Willkommen bei WordPress. Dies ist dein erster Beitrag. Bearbeite oder lösche ihn und beginne mit dem Schreiben!
Hallo Welt!
von raredesign | Dez 3, 2019 | Allgemein | 0 Kommentare
Cokiee Shell
| Current Path : /var/www/web28/html/wp-content/plugins/matomo/classes/WpMatomo/ |
| Current File : //var/www/web28/html/wp-content/plugins/matomo/classes/WpMatomo/ScheduledTasks.php |
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
* @package matomo
*/
namespace WpMatomo;
use Exception;
use Piwik\Container\StaticContainer;
use Piwik\CronArchive;
use Piwik\Filesystem;
use Piwik\Option;
use Piwik\Plugin\Manager;
use Piwik\Plugins\GeoIp2\GeoIP2AutoUpdater;
use Piwik\Plugins\GeoIp2\LocationProvider\GeoIp2;
use Piwik\Plugins\GeoIp2\LocationProvider\GeoIp2\Php;
use Piwik\Plugins\UserCountry\LocationProvider;
use WpMatomo\Admin\Admin;
use WpMatomo\Site\Sync as SiteSync;
use WpMatomo\User\Sync as UserSync;
use WpMatomo\Paths;
if ( ! defined( 'ABSPATH' ) ) {
exit; // if accessed directly
}
class ScheduledTasks {
const EVENT_SYNC = 'matomo_scheduled_sync';
const EVENT_DISABLE_ADDHANDLER = 'matomo_scheduled_disable_addhandler';
const EVENT_ARCHIVE = 'matomo_scheduled_archive';
const EVENT_GEOIP = 'matomo_scheduled_geoipdb';
const EVENT_UPDATE = 'matomo_update_core';
const KEY_BEFORE_CRON = 'before-cron-';
const KEY_AFTER_CRON = 'after-cron-';
const FAILURES_LIST_OPTION = Settings::OPTION_PREFIX . 'scheduled-task-failures';
/**
* @var Settings
*/
private $settings;
/**
* @var Logger
*/
private $logger;
public function __construct( Settings $settings ) {
$this->settings = $settings;
$this->logger = new Logger();
}
public function add_monthly_schedule( $schedules ) {
$schedules['matomo_monthly'] = [
'interval' => 60 * 60 * 24 * 30,
'display' => __( 'Monthly', 'matomo' ),
];
return $schedules;
}
public function schedule() {
add_action( self::EVENT_UPDATE, [ $this, 'perform_update' ] );
add_filter( 'cron_schedules', [ $this, 'add_monthly_schedule' ] );
$self = $this;
$event_priority = 10;
$installer = new Installer( $this->settings );
$looks_installed = $installer->looks_like_it_is_installed(); // we only schedule events when Matomo looks installed but we still listen to the actions in case the app triggers a one time update.
foreach ( $this->get_all_events() as $event_name => $event_config ) {
if ( $looks_installed && wp_next_scheduled( $event_name ) === false ) {
$this->logger->log( "scheduling $event_name for immediate execution, then repeating on the {$event_config['interval']} schedule" );
/** @var \WP_Error $error */
$error = wp_schedule_event( time(), $event_config['interval'], $event_name, [], true );
if ( is_wp_error( $error ) ) {
$this->logger->log_exception( 'scheduled_tasks', new \Exception( "scheduling $event_name failed: " . $error->get_error_message() ) );
}
}
// logging last execution start time
add_action(
$event_name,
function () use ( $self, $event_name ) {
$self->set_last_time_before_cron( $event_name, time() );
},
$event_priority / 2,
$accepted_args = 0
);
// actual event
add_action( $event_name, [ $this, $event_config['method'] ], $event_priority, $accepted_args = 0 );
// logging last execution end time
add_action(
$event_name,
function () use ( $self, $event_name ) {
$self->set_last_time_after_cron( $event_name, time() );
},
$event_priority * 2,
$accepted_args = 0
);
}
register_deactivation_hook( MATOMO_ANALYTICS_FILE, [ $this, 'uninstall' ] );
}
public function get_last_time_before_cron( $event_name ) {
return get_option( Settings::OPTION_PREFIX . self::KEY_BEFORE_CRON . $event_name );
}
public function set_last_time_before_cron( $event_name, $time ) {
// we use settings prefix so data automatically gets removed when uninstalling
update_option( Settings::OPTION_PREFIX . self::KEY_BEFORE_CRON . $event_name, $time );
}
public function get_last_time_after_cron( $event_name ) {
return get_option( Settings::OPTION_PREFIX . self::KEY_AFTER_CRON . $event_name );
}
public function set_last_time_after_cron( $event_name, $time ) {
// we use settings prefix so data automatically gets removed when uninstalling
update_option( Settings::OPTION_PREFIX . self::KEY_AFTER_CRON . $event_name, $time );
}
public function get_all_events() {
$events = [
self::EVENT_SYNC => [
'name' => 'Sync users & sites',
'interval' => 'daily',
'method' => 'sync',
],
self::EVENT_ARCHIVE => [
'name' => 'Archive',
'interval' => 'hourly',
'method' => 'archive',
],
self::EVENT_GEOIP => [
'name' => 'Update GeoIP DB',
'interval' => 'matomo_monthly',
'method' => 'update_geo_ip2_db',
],
];
if ( $this->settings->should_disable_addhandler() ) {
$events[ self::EVENT_DISABLE_ADDHANDLER ] = [
'name' => 'Disable AddHandler',
'interval' => 'hourly',
'method' => 'disable_add_handler',
];
}
return $events;
}
public function disable_add_handler( $force_undo = false ) {
$this->remove_task_errors( [ 'disable_addhandler' ] );
$disable_addhandler = $this->settings->should_disable_addhandler();
if ( $disable_addhandler ) {
$this->logger->log( 'Scheduled tasks disabling addhandler' );
try {
Bootstrap::do_bootstrap();
$files = Filesystem::globr( dirname( MATOMO_ANALYTICS_FILE ), '.htaccess' );
foreach ( $files as $file ) {
if ( is_readable( $file ) ) {
// we don't need to access remote files
// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
$content = file_get_contents( $file );
$search = 'AddHandler';
$replace = '# AddHandler';
if ( $force_undo ) {
$search = '# AddHandler';
$replace = 'AddHandler';
}
if ( strpos( $content, $search ) !== false && ( $force_undo || strpos( $content, $replace ) === false ) ) {
if ( is_writeable( $file ) ) {
$content = str_replace( $search, $replace, $content );
$paths = new Paths();
$wp_filesystem = $paths->get_file_system();
$wp_filesystem->put_contents( $file, $content );
} else {
$this->logger->log( 'Cannot update file as not writable ' . $file );
}
}
}
}
} catch ( Exception $e ) {
$this->on_task_fail( 'disable_addhandler', $e, 'An error occurred when trying to disable AddHandler in apache config.' );
}
}
}
private function check_try_update() {
try {
$installer = new Installer( $this->settings );
if ( $installer->looks_like_it_is_installed() ) {
$updater = new Updater( $this->settings );
$updater->update_if_needed();
}
} catch ( Exception $e ) {
// we don't want to rethrow exception otherwise some other blogs might never sync
$this->logger->log_exception( 'check_try_update', $e );
}
}
public function perform_update() {
$this->remove_task_errors( [ 'cron_update' ] );
$this->logger->log( 'Scheduled tasks perform update' );
try {
$updater = new Updater( $this->settings );
$updater->update();
} catch ( Exception $e ) {
$this->on_task_fail( 'cron_update', $e, 'An error occurred when upgrading the Matomo database tables.' );
return false;
}
return true;
}
public function update_geo_ip2_db( $db_url_override = null, $asn_url_override = null ) {
if ( is_multisite() && ! is_main_site() ) {
return; // only run this task once per entire WP install
}
$this->remove_task_errors( [ 'update_geoip2' ] );
$this->logger->log( 'Scheduled tasks update geoip database' );
try {
Bootstrap::do_bootstrap();
$maxmind_license = $this->settings->get_global_option( 'maxmind_license_key' );
if ( empty( $maxmind_license ) ) {
$db_url = GeoIp2::getDbIpLiteUrl();
$asn_url = GeoIp2::getDbIpLiteUrl( 'asn' );
} else {
$db_url = 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-City&suffix=tar.gz&license_key=' . $maxmind_license;
$asn_url = 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-ASN&suffix=tar.gz&license_key=' . $maxmind_license;
}
if ( ! empty( $db_url_override ) ) {
$db_url = $db_url_override;
}
if ( ! empty( $asn_url_override ) ) {
$asn_url = $asn_url_override;
}
Option::set( GeoIP2AutoUpdater::LOC_URL_OPTION_NAME, $db_url );
if ( Manager::getInstance()->isPluginActivated( 'Provider' ) ) {
Option::set( GeoIP2AutoUpdater::ISP_URL_OPTION_NAME, $asn_url );
} else {
Option::delete( GeoIP2AutoUpdater::ISP_URL_OPTION_NAME );
}
$updater = StaticContainer::get( GeoIP2AutoUpdater::class );
$updater->update();
if ( LocationProvider::getCurrentProviderId() !== Php::ID && LocationProvider::getProviderById( Php::ID ) ) {
LocationProvider::setCurrentProvider( Php::ID );
}
} catch ( Exception $e ) {
$next = wp_next_scheduled( self::EVENT_GEOIP );
if ( false === $next || $next - time() > 2 * 24 * 60 * 60 ) {
wp_schedule_single_event( time() + 24 * 60 * 60, self::EVENT_GEOIP );
}
$this->on_task_fail( 'update_geoip2', $e, 'An error occurred while updating the geolocation database.' );
}
}
public function sync() {
$this->remove_task_errors( [ 'matomo_url_sync', 'cron_sync' ] );
$this->check_try_update();
$this->logger->log( 'Scheduled tasks sync all sites and users' );
try {
// we update the matomo url if needed/when possible. eg an update may be needed when site_url changes
$installer = new Installer( $this->settings );
if ( $installer->looks_like_it_is_installed() ) {
Bootstrap::do_bootstrap();
$installer->set_matomo_url();
}
} catch ( Exception $e ) {
$this->on_task_fail( 'matomo_url_sync', $e, 'An error occurred when syncing the WordPress site URL with Matomo.' );
}
try {
$site = new SiteSync( $this->settings );
$site->sync_all();
$user = new UserSync();
$user->sync_all();
} catch ( Exception $e ) {
$this->on_task_fail( 'cron_sync', $e, 'An error occurred when syncing WordPress sites and users with Matomo.' );
}
}
public function archive( $force = false, $throw_exception = true ) {
$this->check_try_update();
if ( defined( 'MATOMO_DISABLE_WP_ARCHIVING' ) && MATOMO_DISABLE_WP_ARCHIVING ) {
return;
}
$this->remove_task_errors( [ 'archive_bootstrap', 'archive_main' ] );
// exceptions should not be rethrown as they will prevent other cron tasks
// from running (wp-cron.php does not handle exceptions). we only want exceptions
// when running tests.
$should_rethrow_exception = ( defined( 'MATOMO_PHPUNIT_TEST' ) && MATOMO_PHPUNIT_TEST );
$this->logger->log( 'Scheduled tasks archive data' );
try {
Bootstrap::do_bootstrap();
} catch ( Exception $e ) {
if ( $should_rethrow_exception || $force ) {
$this->logger->log_exception( 'archive_bootstrap', $e );
// we want to trigger an exception if it was forced from the UI
throw $e;
}
$this->on_task_fail( 'archive_bootstrap', $e, 'An error occurred during Matomo archiving.' );
return;
}
$archiver = new CronArchive();
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
$archiver->concurrentRequestsPerWebsite = 1;
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
$archiver->maxConcurrentArchivers = 1;
// see https://github.com/matomo-org/matomo/pull/21216
if ( ! CronArchive\SharedSiteIds::isSupported() ) {
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
$archiver->shouldArchiveAllSites = true;
}
if ( $force ) {
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
$archiver->shouldArchiveAllSites = true;
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
$archiver->disableScheduledTasks = true;
// phpcs:disable WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedConstantFound
if ( ! defined( 'PIWIK_ARCHIVE_NO_TRUNCATE' ) ) {
define( 'PIWIK_ARCHIVE_NO_TRUNCATE', true );
}
}
if ( is_multisite() ) {
if ( is_network_admin() ) {
return; // nothing to archive
} else {
$blog_id = get_current_blog_id();
$idsite = Site::get_matomo_site_id( $blog_id );
if ( ! empty( $idsite ) ) {
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
$archiver->shouldArchiveSpecifiedSites = [ $idsite ];
} else {
// there is no site mapped to it so there's no point in archiving it
return;
}
}
}
try {
$archiver->main();
$archive_errors = $archiver->getErrors();
} catch ( Exception $e ) {
$this->on_task_fail( 'archive_main', $e, 'An error occurred during Matomo archiving.' );
$archive_errors = $archiver->getErrors();
if ( ! empty( $archive_errors ) ) {
$message = '';
foreach ( $archiver->getErrors() as $error ) {
// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
$message .= var_export( $error, 1 ) . ' ';
}
$message = new Exception( trim( $message ) );
$this->logger->log_exception( 'archive_errors', $message );
}
if ( $throw_exception ) {
if ( $should_rethrow_exception ) {
throw $e;
}
// we otherwise only log the error but don't throw an exception
} else {
$archive_errors[] = $e->getMessage();
}
}
return $archive_errors;
}
public function uninstall() {
$this->logger->log( 'Scheduled tasks uninstall all events' );
foreach ( $this->get_all_events() as $event_name => $config ) {
$timestamp = wp_next_scheduled( $event_name );
if ( $timestamp ) {
wp_unschedule_event( $timestamp, $event_name );
}
}
foreach ( $this->get_all_events() as $event_name => $config ) {
wp_clear_scheduled_hook( $event_name );
}
}
private function on_task_fail( $log_key, Exception $exception, $user_error_message ) {
$this->logger->log_exception( $log_key, $exception, 'Matomo error - ' . $user_error_message . ' Details: ' );
$failures = $this->get_recorded_task_failures();
$failures[ $log_key ] = $user_error_message;
update_option( self::FAILURES_LIST_OPTION, $failures );
}
private function remove_task_errors( $log_keys ) {
// remove any failures from the list when the task starts again
$failures = $this->get_recorded_task_failures();
if ( empty( $failures ) ) {
return;
}
foreach ( $log_keys as $log_key ) {
unset( $failures[ $log_key ] );
}
update_option( self::FAILURES_LIST_OPTION, $failures );
}
public function get_recorded_task_failures() {
$failures = get_option( self::FAILURES_LIST_OPTION );
if ( ! is_array( $failures ) ) {
$failures = [];
}
return $failures;
}
public function show_errors_if_admin() {
if ( ! is_admin()
|| ! Admin::is_matomo_admin()
) {
return;
}
$matomo_task_failures = $this->get_recorded_task_failures();
if ( empty( $matomo_task_failures ) ) {
return;
}
add_action(
'admin_enqueue_scripts',
function () {
wp_localize_script(
'matomo-admin-js',
'mtmScheduledTaskErrorAjax',
[
'ajax_url' => admin_url( 'admin-ajax.php' ),
'nonce' => wp_create_nonce( 'matomo-scheduled-task-errors' ),
]
);
}
);
add_action(
'admin_notices',
function () use ( $matomo_task_failures ) {
$user = wp_get_current_user();
if ( ! in_array( 'administrator', $user->roles, true ) ) {
return;
}
$matomo_diagnostics_url = home_url( '/wp-admin/admin.php?page=matomo-systemreport#logs' );
include __DIR__ . '/Admin/views/scheduled_tasks_failures.php';
}
);
}
public function register_ajax() {
add_action( 'wp_ajax_mtm_remove_cron_error', [ $this, 'remove_cron_error_ajax' ] );
}
public function remove_cron_error_ajax() {
check_ajax_referer( 'matomo-scheduled-task-errors' );
// phpcs:disable WordPress.Security.NonceVerification.Missing
if ( empty( $_POST['matomo_job_id'] ) ) {
wp_send_json( false );
return;
}
// phpcs:disable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$job_id = wp_unslash( $_POST['matomo_job_id'] );
$this->remove_task_errors( [ $job_id ] );
wp_send_json( true );
}
}
Cokiee Shell Web 1.0, Coded By Razor
Neueste Kommentare