#!/bin/bash

####################################################################################################
#### author: SlickStack ############################################################################
#### link: https://slickstack.io ###################################################################
#### mirror: https://mirrors.slickstack.io/bash/ss-purge-opcache.txt ###############################
#### path: /var/www/ss-purge-opcache ###############################################################
#### destination: n/a (not a boilerplate) ##########################################################
#### purpose: Clears the PHP-FPM OPcache by deleting files under /var/www/cache/opcache/ ###########
#### module version: PHP-FPM 8.1.x #################################################################
#### sourced by: ss-purge, ss core bash scripts ####################################################
#### bash aliases: ss purge [clear] opcache, ss purge [clear] caches opcache #######################
####################################################################################################

## RUNNING SS-PURGE DURING TRAFFIC SPIKES MIGHT CAUSE SUDDEN STRESS TO SERVER RESOURCES ##
## KEEP IN MIND THAT PAGE CACHING IS DISABLED ALREADY ON DEV/STAGING WEBSITES ##

## source ss-config ##
source /var/www/ss-config

## source ss-functions ##
source /var/www/ss-functions

## BELOW THIS RELIES ON SS-CONFIG AND SS-FUNCTIONS

####################################################################################################
#### TABLE OF CONTENTS (SS-Purge-OPcache) ##########################################################
####################################################################################################

## this is a brief summary of the different code snippets you will find in this script ##
## each section should be commented so you understand what is being accomplished ##

## A. Touch Timestamp File
## B. Message (Begin Script)

####################################################################################################
#### A. SS-Purge-OPcache: Touch Timestamp File #####################################################
####################################################################################################

## this is a dummy timestamp file that will remember the last time this script was run ##
## it can be useful for developer reference and is sometimes used by SlickStack ##

## script timestamp ##
ss_touch "${TIMESTAMP_SS_PURGE_OPCACHE}"

####################################################################################################
#### B. SS-Purge-OPcache: Message (Begin Script) ###################################################
####################################################################################################

## this is a simple message that announces to the shell the purpose of this bash script ##
## it will only be noticed by sudo users who manually call ss core bash scripts ##

## echo message ##
ss_echo "${COLOR_INFO}Running ss-purge-opcache: Clears the PHP-FPM OPcache by deleting files under /var/www/cache/opcache/... ${COLOR_RESET}"

####################################################################################################
#### SS-Purge-OPcache: Clear Cache (PHP-FPM OPcache) ###############################################
####################################################################################################

## by default OPcache only caches PHP files for a few seconds but we clear it to be sure ##
## this snippet will also clear physical OPcache files if the feature is enabled ##

if [[ "${SS_APP}" != "mysql" ]]; then

## manually delete OPcache file cache (after opcache file cache works better) ##
# rm /var/www/cache/opcache/*

## creative way to reset OPcache using temporary PHP script ##
RANDOM_RESET_OPCACHE=$(openssl rand -hex 12)
echo "<?php opcache_reset(); ?>" > /var/www/html/purge-${RANDOM_RESET_OPCACHE}.php
/usr/bin/php /var/www/html/purge-${RANDOM_RESET_OPCACHE}.php
rm /var/www/html/purge-*.php

## manually delete OPcache file cache (again) ##
# rm /var/www/cache/opcache/*
# rm "$PATH_CACHE_OPCACHE"*

fi

####################################################################################################
#### SlickStack: External References Used To Improve This Script (Thanks, Interwebz) ###############
####################################################################################################

## Ref: https://www.php.net/manual/en/function.opcache-reset.php#121513
## Ref: https://stackoverflow.com/questions/5506913/bash-script-to-run-php-script
## Ref: https://coderwall.com/p/yrqrkw/delete-all-existing-wordpress-transients-in-mysql-database
## Ref: https://stackoverflow.com/questions/10422574/can-i-remove-transients-in-the-wp-options-table-of-my-wordpress-install
## Ref: https://wordpress.stackexchange.com/questions/73477/is-there-any-danger-in-deleting-all-transients
## Ref: https://stackoverflow.com/questions/20033648/how-to-run-mysql-command-on-bash
## Ref: https://serverfault.com/questions/337818/how-to-force-mysql-to-connect-by-tcp-instead-of-a-unix-socket
## Ref: https://stackoverflow.com/questions/33067909/bash-variable-under-a-mysql-query
## Ref: https://dev.mysql.com/doc/refman/5.7/en/examples.html
## Ref: https://stackoverflow.com/questions/25044817/zend-opcache-opcache-enable-cli-1-or-0-what-does-it-do#comment91052089_35880017
## Ref: https://codex.wordpress.org/Class_Reference/WP_Object_Cache
## Ref: https://pressidium.com/blog/2017/wordpress-object-caching-redis-memcached-and-native-apis/
## Ref: https://pressjitsu.com/blog/transient-cache-alternatives/
## Ref: https://unix.stackexchange.com/questions/87258/delete-all-files-except-in-a-certain-subdirectory-with-find
## Ref: https://github.com/littlebizzy/slickstack/issues/57

## SS_EOF