API
2 weeks ago
Access
2 weeks ago
Application
2 weeks ago
Archive
2 weeks ago
ArchiveProcessor
2 weeks ago
Archiver
2 years ago
AssetManager
2 weeks ago
Auth
2 weeks ago
Category
2 weeks ago
Changes
2 months ago
CliMulti
2 weeks ago
Columns
2 weeks ago
Concurrency
2 weeks ago
Config
2 weeks ago
Container
2 months ago
CronArchive
2 weeks ago
DataAccess
2 weeks ago
DataFiles
2 years ago
DataTable
2 weeks ago
Db
2 weeks ago
DeviceDetector
1 year ago
Email
2 years ago
Exception
5 months ago
Http
2 weeks ago
Intl
4 months ago
Log
2 years ago
Mail
1 year ago
Measurable
8 months ago
Menu
2 weeks ago
Metrics
2 weeks ago
Notification
8 months ago
Period
2 weeks ago
Plugin
2 weeks ago
Policy
2 months ago
ProfessionalServices
1 year ago
Report
1 year ago
ReportRenderer
2 weeks ago
Request
2 weeks ago
Scheduler
2 weeks ago
Segment
2 weeks ago
Session
1 month ago
Settings
2 weeks ago
Tracker
2 weeks ago
Translation
2 months ago
Twig
1 year ago
UpdateCheck
4 months ago
Updater
2 weeks ago
Updates
1 month ago
Validators
1 year ago
View
2 months ago
ViewDataTable
2 weeks ago
Visualization
2 weeks ago
Widget
2 weeks ago
.htaccess
2 years ago
Access.php
2 weeks ago
Archive.php
2 months ago
ArchiveProcessor.php
2 weeks ago
AssetManager.php
2 weeks ago
Auth.php
8 months ago
AuthResult.php
8 months ago
BaseFactory.php
2 years ago
Cache.php
2 weeks ago
CacheId.php
5 months ago
CliMulti.php
2 weeks ago
Common.php
2 weeks ago
Config.php
2 weeks ago
Console.php
4 months ago
Context.php
2 years ago
Cookie.php
2 weeks ago
CronArchive.php
2 weeks ago
DI.php
4 months ago
DataArray.php
2 weeks ago
DataTable.php
2 weeks ago
Date.php
2 months ago
Db.php
2 months ago
DbHelper.php
2 weeks ago
Development.php
2 weeks ago
ErrorHandler.php
8 months ago
EventDispatcher.php
2 months ago
ExceptionHandler.php
5 months ago
FileIntegrity.php
2 weeks ago
Filechecks.php
1 year ago
Filesystem.php
2 weeks ago
FrontController.php
2 weeks ago
Http.php
2 weeks ago
IP.php
1 year ago
Log.php
4 months ago
LogDeleter.php
2 weeks ago
Mail.php
1 year ago
Metrics.php
2 months ago
NoAccessException.php
2 years ago
Nonce.php
8 months ago
Notification.php
2 months ago
NumberFormatter.php
2 weeks ago
Option.php
2 weeks ago
Period.php
2 weeks ago
Piwik.php
2 weeks ago
Plugin.php
2 months ago
Process.php
2 months ago
Profiler.php
2 weeks ago
ProxyHeaders.php
5 months ago
ProxyHttp.php
2 weeks ago
QuickForm2.php
4 months ago
RankingQuery.php
2 months ago
ReportRenderer.php
2 weeks ago
Request.php
2 months ago
Segment.php
2 weeks ago
Sequence.php
2 weeks ago
Session.php
1 month ago
SettingsPiwik.php
2 weeks ago
SettingsServer.php
2 weeks ago
Singleton.php
2 years ago
Site.php
2 months ago
SiteContentDetector.php
2 months ago
SupportedBrowser.php
2 years ago
TCPDF.php
1 year ago
Theme.php
2 weeks ago
Timer.php
2 weeks ago
Tracker.php
2 weeks ago
Twig.php
2 months ago
Unzip.php
1 year ago
UpdateCheck.php
2 months ago
Updater.php
2 weeks ago
UpdaterErrorException.php
2 years ago
Updates.php
2 weeks ago
Url.php
2 weeks ago
UrlHelper.php
2 months ago
Version.php
2 weeks ago
View.php
2 weeks ago
bootstrap.php
1 year ago
dispatch.php
2 years ago
testMinimumPhpVersion.php
8 months ago
Updates.php
116 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik; |
| 10 | |
| 11 | use Piwik\Updater\Migration; |
| 12 | /** |
| 13 | * Base class for update scripts. |
| 14 | * |
| 15 | * Update scripts perform version updates for Piwik core or individual plugins. They can run |
| 16 | * SQL queries and/or PHP code to update an environment to a newer version. |
| 17 | * |
| 18 | * To create a new update script, create a class that extends `Updates`. Name the class and file |
| 19 | * after the version, eg, `class Updates_3_0_0` and `3.0.0.php`. Override the {@link getMigrations()} |
| 20 | * method if you need to run SQL queries. Override the {@link doUpdate()} method to do other types |
| 21 | * of updating, eg, to activate/deactivate plugins or create files. |
| 22 | * |
| 23 | * @example core/Updates/0.4.2.php |
| 24 | */ |
| 25 | abstract class Updates |
| 26 | { |
| 27 | /** |
| 28 | * Return migrations to be executed in this update. |
| 29 | * |
| 30 | * Migrations should be defined here, instead of in `doUpdate()`, since this method is used to display a preview |
| 31 | * of which migrations and database queries an update will run. If you execute migrations directly in `doUpdate()`, |
| 32 | * they won't be displayed to the user. |
| 33 | * |
| 34 | * @return Migration[] |
| 35 | * @api |
| 36 | */ |
| 37 | public function getMigrations(\Piwik\Updater $updater) |
| 38 | { |
| 39 | return array(); |
| 40 | } |
| 41 | /** |
| 42 | * Perform the incremental version update. |
| 43 | * |
| 44 | * This method should perform all updating logic. If you define migrations in an overridden `getMigrations()` |
| 45 | * method, you must call {@link Updater::executeMigrations()} here. |
| 46 | * |
| 47 | * See {@link \Piwik\Plugins\ExamplePlugin\Updates\Updates_0_0_2} for an example. |
| 48 | * |
| 49 | * @api |
| 50 | */ |
| 51 | public function doUpdate(\Piwik\Updater $updater) |
| 52 | { |
| 53 | } |
| 54 | /** |
| 55 | * Tell the updater that this update has major operational impact. |
| 56 | * |
| 57 | * This is not tied to semantic major versions. Use it for product-level changes that can |
| 58 | * require substantial work or downtime on large instances, such as modifying large db tables. |
| 59 | * |
| 60 | * NOTE to release manager: Remember to mention in the Changelog |
| 61 | * that this update contains major DB upgrades and will take some time! |
| 62 | * |
| 63 | * @return bool |
| 64 | */ |
| 65 | public static function isMajorUpdate() |
| 66 | { |
| 67 | return \false; |
| 68 | } |
| 69 | /** |
| 70 | * Enables maintenance mode. Should be used for updates where Piwik will be unavailable |
| 71 | * for a large amount of time. |
| 72 | */ |
| 73 | public static function enableMaintenanceMode() |
| 74 | { |
| 75 | $config = \Piwik\Config::getInstance(); |
| 76 | $tracker = $config->Tracker; |
| 77 | $tracker['record_statistics'] = 0; |
| 78 | $config->Tracker = $tracker; |
| 79 | $general = $config->General; |
| 80 | $general['maintenance_mode'] = 1; |
| 81 | $config->General = $general; |
| 82 | $config->forceSave(); |
| 83 | } |
| 84 | /** |
| 85 | * Helper method to disable maintenance mode after large updates. |
| 86 | */ |
| 87 | public static function disableMaintenanceMode() |
| 88 | { |
| 89 | $config = \Piwik\Config::getInstance(); |
| 90 | $tracker = $config->Tracker; |
| 91 | $tracker['record_statistics'] = 1; |
| 92 | $config->Tracker = $tracker; |
| 93 | $general = $config->General; |
| 94 | $general['maintenance_mode'] = 0; |
| 95 | $config->General = $general; |
| 96 | $config->forceSave(); |
| 97 | } |
| 98 | public static function deletePluginFromConfigFile($pluginToDelete) |
| 99 | { |
| 100 | $config = \Piwik\Config::getInstance(); |
| 101 | if (isset($config->Plugins['Plugins'])) { |
| 102 | $plugins = $config->Plugins['Plugins']; |
| 103 | if (($key = array_search($pluginToDelete, $plugins)) !== \false) { |
| 104 | unset($plugins[$key]); |
| 105 | } |
| 106 | $config->Plugins['Plugins'] = $plugins; |
| 107 | $pluginsInstalled = $config->PluginsInstalled['PluginsInstalled']; |
| 108 | if (($key = array_search($pluginToDelete, $pluginsInstalled)) !== \false) { |
| 109 | unset($pluginsInstalled[$key]); |
| 110 | } |
| 111 | $config->PluginsInstalled = array('PluginsInstalled' => $pluginsInstalled); |
| 112 | $config->forceSave(); |
| 113 | } |
| 114 | } |
| 115 | } |
| 116 |