{$out}
"); $form->append($field); } } /** * Delete data older than defined interval * * @param null|string|int|HookEvent $interval Interval, defaults to data_max_age setting * @param null|int $max_rows max rows of data, defaults to data_max_rows setting */ public function cleanup($interval = null, ?int $max_rows = null) { // called via LazyCron or null value provided for interval, get data_max_age from module config if ($interval instanceof HookEvent || $interval === null) { $interval = empty($this->data_max_age) ? null : $this->data_max_age; } // in case interval is "num_days", get value from the data_max_age_days setting instead if ($interval === 'num_days') { $interval = $this->data_max_age_days ? (int) $this->data_max_age_days : null; } // define number of rows $max_rows = $max_rows ?? $this->data_max_rows ?? null; $max_rows = $max_rows !== null && (int) $max_rows == $max_rows && (int) $max_rows > 0 ? (int) $max_rows : null; // delete old data from database if ($interval !== null) { $interval = is_int($interval) ? $interval . ' DAY' : $this->database->escapeStr($interval); $sql = "DELETE FROM " . self::TABLE_NAME . " WHERE timestamp < DATE_SUB(NOW(), INTERVAL $interval)"; try { $this->database->exec($sql); } catch(\Exception $e) { $this->error($e->getMessage()); } } // delete extraneous rows from database if ($max_rows !== null) { try { $last_removable_row_query = $this->database->query('SELECT id, timestamp FROM ' . self::TABLE_NAME . ' ORDER BY timestamp DESC, id DESC LIMIT ' . $max_rows . ', 1'); $last_removable_row = $last_removable_row_query->fetch(\PDO::FETCH_NUM); if ($last_removable_row !== false) { list($last_removable_row_id, $max_timestamp) = $last_removable_row; $row_number = $this->database->query('SELECT COUNT(*) FROM ' . self::TABLE_NAME)->fetchColumn(); if ($row_number !== false && (int) $row_number == $row_number && $row_number > $max_rows) { $sql = 'DELETE FROM ' . self::TABLE_NAME . ' WHERE timestamp <= :max_timestamp AND id <= :last_removable_row_id ORDER BY timestamp ASC, id ASC LIMIT :limit'; $stmt = $this->database->prepare($sql); $stmt->bindValue(':max_timestamp', $max_timestamp, \PDO::PARAM_STR); $stmt->bindValue(':last_removable_row_id', $last_removable_row_id, \PDO::PARAM_INT); $stmt->bindValue(':limit', $row_number - $max_rows, \PDO::PARAM_INT); $stmt->execute(); } } } catch(\Exception $e) { $this->error($e->getMessage()); } } } /** * This method gets triggered when module config is saved * * @param HookEvent $event */ protected function saveConfig(HookEvent $event) { // bail out early if saving another module's config $class = $event->arguments[0]; if (is_string($class) && $class !== $this->className || is_object($class) && $class != $this) { return; } // check if "prune data now" option is checked $data = $event->arguments[1]; if (is_array($data) && !empty($data['prune_data_now']) || $data === 'prune_data_now' && !empty($event->arguments[2])) { // make sure that latest values are used in case data retention rules are saved during current request $interval = is_array($data) && !empty($data['data_max_age']) ? $data['data_max_age'] : null; if ($interval === 'num_days') { $interval = !empty($data['data_max_age_days']) ? (int) $data['data_max_age_days'] : null; } $max_rows = is_array($data) && !empty($data['data_max_rows']) ? $data['data_max_rows'] : null; // prune data $is_valid_interval = $interval !== null || !is_array($data) && $this->data_max_age && ($this->data_max_age !== 'num_days' || !empty($this->data_max_age_days)); $is_valid_rows = $max_rows !== null; if ($is_valid_interval || $is_valid_rows) { $this->cleanup($interval, $max_rows); $this->message($this->_('Data was pruned according to rules specified by configured data retention settings.')); } else { $this->warning($this->_('Module settings were saved but data retention rules were not specified, so no data was pruned.')); } // make sure that "prune data now" option value doesn't get saved if (is_array($data)) { unset($data['prune_data_now']); $event->arguments(1, $data); } $event->arguments(2, null); } } /** * Based on event method and other information available this * method parses required data and triggers insert method. * * @param HookEvent $event */ public function logPageEvent(HookEvent $event) { // variables from event $page = $event->arguments[0]; $field = isset($event->arguments[1]) && $event->arguments[1] instanceof Field ? $event->arguments[1] : null; $operation = $event->method == "saveReady" || $event->method == "saveFieldReady" ? "edited" : $event->method; // check if this event should be logged if (!$this->shouldLogPageEvent($page, $field, $operation)) { return; } $fields_edited = []; if ($operation == "edited") { // skip new pages or pages being restored/trashed if (!$page->id || $page->parentPrevious) return; if ($page->isChanged()) { if ($field && $page->isChanged($field->name)) { // only one field was edited (saveFieldReady) $fields_edited[$field->id] = $field->name; } else { // one or more fields were edited (saveReady) foreach ($page->template->fields as $field) { if ($page->isChanged($field->name)) { $fields_edited[$field->id] = $field->name; } } } // filter out any ignored fields if (!empty($this->ignored_fields) && !empty($fields_edited)) { $fields_edited = array_diff_key($fields_edited, array_flip($this->ignored_fields)); } // only continue if at least one field has been changed (and // if status has changed, trigger a new event for that) if (empty($fields_edited)) { if ($page->isChanged("status")) { $this->triggerStatusEvents($event); } if ($this->modules->isInstalled("LanguageSupportPageNames")) { // if multi-language page names are enabled, we need to // fake a rename action when non-default name changes if ($changes = $page->getChanges()) { foreach ($changes as $change) { if (strpos($change, "name") === 0 && preg_match("/^name([0-9]+)$/", $change, $matches)) { $lang = $this->languages->get((int) $matches[1]); if ($lang && $lang->id) { $this->pages->uncache($page); $event->pageNamePrevious = $this->pages->get($page->id)->get($change) ?: $page->name; $event->pageName = $page->get($change); $event->pageURL = $page->localUrl($lang); $event->method = "renamed"; $this->logPageEvent($event); } } } } } return; } } else { // nothing has changed return; } } else if ($operation == "renamed") { // if previous parent is trash, page is being restored if ($page->parentPrevious instanceof Page && $page->parentPrevious->id == $this->config->trashPageID) return; // if current parent is trash, page is being trashed else if ($page->parent->id == $this->config->trashPageID) return; } else if ($operation == "moved") { if ($page->parent->id == $this->config->trashPageID) { // page is being trashed $operation = "trashed"; } else if ($page->parentPrevious->id == $this->config->trashPageID) { // page is being restored $operation = "restored"; } } // details about page being edited, trashed, moved etc. // note: if details are null, this means that we shouldn't log this event $details = $this->getPageEventDetails($page, $event, $operation, $fields_edited); if ($details === null) return; $this->insert($operation, $page->id, $page->template->id, $details); // if status has changed and current event doesn't reflect that, log extra event(s) if ($page->isChanged('status') && !in_array($operation, ["unpublished", "published", "hid", "unhid"])) { $this->triggerStatusEvents($event); } } /** * Get details about page being edited, trashed, moved etc. * * @param Page $page * @param HookEvent $event * @param string $operation * @param array $fields_edited * @return array|null */ protected function ___getPageEventDetails(Page $page, HookEvent $event, string $operation, array $fields_edited): ?array { $details = [ 'Page title' => $page->title, 'Page name' => $event->pageName ?: $page->name, 'Previous page name' => $event->pageNamePrevious ?: $page->namePrevious, 'Page URL' => $event->pageURL ?: $page->url, 'Previous page URL' => null, 'Template name' => $page->template->name, 'Previous template name' => $page->templatePrevious ? $page->templatePrevious->name : null, 'Fields edited' => empty($fields_edited) ? null : implode(', ', $fields_edited), ]; if ($operation == 'moved') { $details['Page name'] = $details['Previous page name']; unset($details['Previous page name']); } if ($page->id === 1 && $this->modules->isInstalled('LanguageSupportPageNames')) { $details['Page URL'] = '/' . ($page->name && $page->name !== Pages::defaultRootName ? $page->name . '/' : ''); } if ($page->parentPrevious && $operation != 'edited') { // for pages being edited, current or previous parent is irrelevant (changing the parent will also trigger "moved" operation) $details['Previous page URL'] = $page->parentPrevious->url . ($page->namePrevious ?: $page->name) . '/'; } else if ($operation == 'renamed') { if ($page->id === 1 && $this->modules->isInstalled('LanguageSupportPageNames')) { $details['Previous page URL'] = '/' . ($page->namePrevious && $page->namePrevious !== Pages::defaultRootName ? $page->namePrevious . '/' : ''); } else if ($event->pageNamePrevious || $page->namePrevious) { $details['Previous page URL'] = ($page->parent->url ?: '/') . ($event->pageNamePrevious ?: $page->namePrevious) . '/'; } } // find out which script or URL triggered this particular action if ($this->log_caller && $caller = $this->getCaller()) { $details['Caller'] = $caller; } $details = array_filter($details, function($value) { return $value !== null && $value !== ''; }); // prevent duplicate events for the same page $event_hash = $page->id . '.' . $operation . '.' . md5(json_encode($details)); if ($this->previous_event_hash == $event_hash) { return null; } $this->previous_event_hash = $event_hash; return $details; } /** * Should we log this Page event? * * @param Page $page * @param Field|null $field * @param string $operation * @return bool */ protected function ___shouldLogPageEvent(Page $page, ?Field $field, $operation) { // don't log notifications if ($operation == "edited" && $field == "notifications" && $page instanceof User) { return false; } // don't log operations for repeaters or admin pages if ($page instanceof RepeaterPage || $page->template == "admin") { return false; } // don't log operations for ignored templates if (!empty($this->ignored_templates) && in_array($page->template->id, $this->ignored_templates)) { return false; } // don't log operations by ignored user roles if (!empty($this->ignored_roles)) { foreach ($this->ignored_roles as $ignored_role) { if ($ignored_role == $this->config->guestUserRolePageID) { // Note: guest role needs special treatment, or ignoring it wouldn't be of any // real use. In this case we'll only ignore users with **only** the guest role. if ($this->user->roles->count == 1) { return false; } } else if ($this->user->hasRole($ignored_role)) { return false; } } } // don't log operations by ignored users if (!empty($this->ignored_users) && in_array($this->user->id, $this->ignored_users)) { return false; } // only continue if this operation is set to be logged if (!in_array($operation, $this->operations)) { return false; } return true; } /** * Trigger additional status-related events for given event * * @param HookEvent $event */ private function triggerStatusEvents(HookEvent $event) { $page = $event->arguments[0]; // was this page was hidden or unhidden? if ((bool) $page->is(Page::statusHidden) !== (bool) ($page->statusPrevious & Page::statusHidden)) { $event->method = $page->is(Page::statusHidden) ? "hid" : "unhid"; $this->logPageEvent($event); } // was this page published or unpublished? if ((bool) $page->is(Page::statusUnpublished) !== (bool) ($page->statusPrevious & Page::statusUnpublished)) { $event->method = $page->is(Page::statusUnpublished) ? "unpublished" : "published"; $this->logPageEvent($event); } } /** * Find out which script / URL triggered current action * * @return string|null */ private function getCaller() { $index = $this->config->paths->root . "index.php"; $caller = realpath($_SERVER['SCRIPT_FILENAME']); $caller_is_processwire = $caller === $index; if (isset($_SERVER['HTTP_HOST'])) { if (!isset($_SERVER['REQUEST_URI'])) { // IIS support, based on http://davidwalsh.name/iis-php-server-request_uri $qs = isset($_SERVER['QUERY_STRING']) ? "?" . $_SERVER['QUERY_STRING'] : ""; $_SERVER['REQUEST_URI'] = substr($_SERVER['PHP_SELF'], 1) . $qs; } $scheme = $this->config->https ? "https://" : "http://"; $caller = $scheme . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; } if ($this->log_caller == "all" || !$caller_is_processwire) { return $caller; } } /** * Insert row into database * * @param string $operation * @param int $pages_id * @param int $templates_id * @param array $details * * @throws WireException if operation is unknown */ private function insert($operation, $pages_id, $templates_id, $details = []) { if (!in_array($operation, $this->operations)) { throw new WireException('Unknown operation'); } $pages_id = (int) $pages_id; $templates_id = (int) $templates_id; $user_id = (int) $this->user->id; $username = $this->user->name; // validate and encode details to JSON if ($details) { foreach ($details as &$detail) { $detail = str_replace("'", "", $detail); $detail = wire()->sanitizer->text($detail); } $details = json_encode($details); } else $details = null; // insert new row into database $sql = "INSERT INTO " . self::TABLE_NAME . " " . "(user_id, username, pages_id, templates_id, operation, data) VALUES " . "(:user_id, :username, :pages_id, :templates_id, :operation, :data) "; try { $stmt = $this->database->prepare($sql); $stmt->bindValue(':user_id', $user_id, \PDO::PARAM_INT); $stmt->bindValue(':username', $username, \PDO::PARAM_STR); $stmt->bindValue(':pages_id', $pages_id, \PDO::PARAM_INT); $stmt->bindValue(':templates_id', $templates_id, \PDO::PARAM_INT); $stmt->bindValue(':operation', $operation, \PDO::PARAM_STR); $stmt->bindValue(':data', $details, \PDO::PARAM_STR); $stmt->execute(); } catch(\Exception $e) { $this->error($e->getMessage()); } } /** * Update database schema * * This method applies incremental updates until latest schema version is * reached, while also keeping schema_version config setting up to date. * * @param bool $force Force schema update, ignoring any checks. * * @throws WireException if database schema version isn't recognized */ public function updateDatabaseSchema($force = false) { while ($this->schema_version < self::SCHEMA_VERSION) { // by default an update can be performed by any user behind the scenes $can_update = true; // increment; defaults to 1, but in some cases we may be able to skip over a specific schema update $increment = 1; // first we need to figure out which update we're going to trigger, and whether it's one that can be // triggered in the backgroudn without superuser intervention switch ($this->schema_version) { case 1: // update #1: add templates_id column $sql = [ "ALTER TABLE `" . self::TABLE_NAME . "` ADD `templates_id` INT(10) UNSIGNED NOT NULL DEFAULT 0 AFTER `pages_id`", ]; break; case 2: // update #2: add indexes for templates_id and username $can_update = $force || ($this->user->isSuperuser() && $this->input->get->update_changelog_database_schema == 2); if ($can_update) { set_time_limit(600); $sql = [ "ALTER TABLE `" . self::TABLE_NAME . "` ADD INDEX `templates_id` (`templates_id`), ADD INDEX `username` (`username`)", ]; } break; case 3: // update #3: drop index for pages_id, add index for pages_id + id $can_update = $force || ($this->user->isSuperuser() && $this->input->get->update_changelog_database_schema == 3); if ($can_update) { set_time_limit(600); $sql = [ "ALTER TABLE `" . self::TABLE_NAME . "` DROP INDEX `pages_id`", "ALTER TABLE `" . self::TABLE_NAME . "` ADD INDEX `pages_id__id` (`pages_id`, `id`)", ]; } break; default: throw new WireException("Unrecognized database schema version: {$this->schema_version}"); } // this update needs to be triggered manually by superuser, just in case; display a notification and // call to action button if current user is a superuser, otherwise just keep on keeping on if (!$can_update) { if (!$this->user->isLoggedin()) { $this->addHookAfter('ProcessLogin::loginSuccess', function(HookEvent $event) { if ($event->user->isSuperuser()) { $event->message($this->getDatabaseSchemaUpdateNotice(), Notice::allowMarkup); } }); } return; } // we're ready to execute this update foreach ($sql as $sql_query) { $schema_updated = $this->executeDatabaseSchemaUpdate($sql_query); if (!$schema_updated) { break; } } // if update fails: log, show notice (if current user is superuser) and continue if (!$schema_updated) { $message = sprintf( $this->_("Running database schema update %d failed"), $this->schema_version ); $this->log->save('process-changelog', $message); if ($this->user->isSuperuser()) { $this->message($message); } return; } // all's well that ends well $this->schema_version += $increment; $configData = $this->modules->getModuleConfigData($this); $configData['schema_version'] = $this->schema_version; $this->modules->saveModuleConfigData($this, $configData); if ($this->user->isSuperuser()) { $this->message(sprintf( $this->_('ProcessChangelog database schema update applied (#%d).'), $this->schema_version - 1 )); } } } /** * Execute database schema update * * @param string $sql * @return bool */ protected function executeDatabaseSchemaUpdate($sql): bool { try { $updated_rows = $this->database->exec($sql); return $updated_rows !== false; } catch (\PDOException $e) { if (isset($e->errorInfo[1]) && in_array($e->errorInfo[1], [1060, 1061, 1091])) { // 1060 (column already exists), 1061 (duplicate key name), and 1091 (can't drop index) are errors that // can be safely ignored here; the most likely issue would be that this update has already been applied return true; } // another type of error; log, show notice (if current user is superuser) and return false $message = sprintf( 'Error updating schema: %s (%s)', $e->getMessage(), $e->getCode() ); $this->log->save('process-changelog', $message); if ($this->user->isSuperuser()) { $this->error($message); } return false; } } /** * Get database schema update notice * * @return string */ protected function getDatabaseSchemaUpdateNotice() { return sprintf( $this->_('ProcessChangelog has pending database schema update (#%d). This update may take a while to complete. If an error occurs, module README file contains additional instructions. %s.'), $this->schema_version, sprintf( '%s', $this->config->urls->admin . 'module/edit/?name=ProcessChangelogHooks&update_changelog_database_schema=' . (int) $this->schema_version, $this->_('Update database schema now') ) ); } /** * Called only when this module is installed * * Creates new custom database table for storing data. */ public function ___install() { // create required database table. note that updateDatabaseSchema will // make changes to it's schema, so it's not guaranteed to stay as-is. $sql = " CREATE TABLE " . self::TABLE_NAME . " ( id INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY, user_id INT(10) UNSIGNED NOT NULL DEFAULT 0, username VARCHAR(128) DEFAULT NULL, pages_id INT(10) UNSIGNED NOT NULL DEFAULT 0, operation VARCHAR(128) NOT NULL, data TEXT DEFAULT NULL, timestamp TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ) ENGINE = MYISAM; "; $this->database->exec($sql); // tell the user that we've created new database table $this->message("Created Table: " . self::TABLE_NAME); // update database schema, overriding any checks $this->updateDatabaseSchema(true); } /** * Called only when this module is uninstalled * * Drops database table created during installation. */ public function ___uninstall() { $this->message("Removing database table: " . self::TABLE_NAME); $this->database->exec("DROP TABLE IF EXISTS " . self::TABLE_NAME); } }