Cleaners
5 months ago
Exceptions
5 years ago
Cancel.php
8 months ago
CancelUpdate.php
8 months ago
Cloning.php
1 week ago
CloningProcess.php
1 week ago
Data.php
8 months ago
Database.php
1 week ago
Delete.php
1 week ago
Directories.php
6 months ago
Files.php
1 month ago
Finish.php
5 days ago
Job.php
1 week ago
JobExecutable.php
8 months ago
Logs.php
3 years ago
PreserveDataFirstStep.php
2 months ago
PreserveDataSecondStep.php
2 months ago
ProcessLock.php
1 year ago
Scan.php
1 month ago
SearchReplace.php
7 months ago
TotalStepsAreNumberOfTables.php
5 years ago
Updating.php
1 week ago
Finish.php
198 lines
| 1 | <?php |
| 2 | |
| 3 | namespace WPStaging\Backend\Modules\Jobs; |
| 4 | |
| 5 | use WPStaging\Core\WPStaging; |
| 6 | use WPStaging\Framework\Analytics\Actions\AnalyticsStagingCreate; |
| 7 | use WPStaging\Framework\Analytics\Actions\AnalyticsStagingReset; |
| 8 | use WPStaging\Framework\Analytics\Actions\AnalyticsStagingUpdate; |
| 9 | use WPStaging\Framework\Logger\EventLoggerConst; |
| 10 | use WPStaging\Staging\Sites; |
| 11 | use WPStaging\Framework\Traits\EventLoggerTrait; |
| 12 | use WPStaging\Framework\Utils\Urls; |
| 13 | use WPStaging\Staging\Jobs\StagingSiteCreate; |
| 14 | |
| 15 | /** |
| 16 | * Class Finish |
| 17 | * @package WPStaging\Backend\Modules\Jobs |
| 18 | */ |
| 19 | class Finish extends Job |
| 20 | { |
| 21 | use EventLoggerTrait; |
| 22 | |
| 23 | /** |
| 24 | * Clone Key |
| 25 | * @var string |
| 26 | */ |
| 27 | private $clone = ''; |
| 28 | |
| 29 | /** |
| 30 | * @var Urls |
| 31 | */ |
| 32 | private $urls; |
| 33 | |
| 34 | /** |
| 35 | * Start Module |
| 36 | * @return object |
| 37 | * @throws \Exception |
| 38 | */ |
| 39 | public function start() |
| 40 | { |
| 41 | $this->urls = WPStaging::make(Urls::class); |
| 42 | |
| 43 | // sanitize the clone name before saving |
| 44 | $this->clone = preg_replace("#\W+#", '-', strtolower($this->options->clone)); |
| 45 | |
| 46 | $this->deleteCacheFiles(); |
| 47 | |
| 48 | // Prepare clone records & save scanned directories for delete job later |
| 49 | $this->prepareCloneDataRecords(); |
| 50 | |
| 51 | $this->options->isRunning = false; |
| 52 | |
| 53 | $return = [ |
| 54 | "directoryName" => $this->options->cloneDirectoryName, |
| 55 | "path" => trailingslashit($this->options->destinationDir), |
| 56 | "url" => $this->getDestinationUrl(), |
| 57 | "number" => $this->options->cloneNumber, |
| 58 | "version" => WPStaging::getVersion(), |
| 59 | "status" => 'finished', |
| 60 | "prefix" => $this->options->prefix, |
| 61 | "last_msg" => $this->logger->getLastLogMsg(), |
| 62 | "job" => $this->options->currentJob, |
| 63 | "percentage" => 100, |
| 64 | ]; |
| 65 | |
| 66 | $processType = EventLoggerConst::PROCESS_PREFIX_CLONE; |
| 67 | $successMessage = "Staging site successfully created"; |
| 68 | switch ($this->options->mainJob) { |
| 69 | case Job::STAGING: |
| 70 | WPStaging::make(AnalyticsStagingCreate::class)->enqueueFinishEvent($this->options->jobIdentifier, $this->options); |
| 71 | do_action(StagingSiteCreate::ACTION_STAGING_SITE_CREATED, $this->options); |
| 72 | break; |
| 73 | case Job::UPDATE: |
| 74 | $processType = EventLoggerConst::PROCESS_PREFIX_CLONE_UPDATE; |
| 75 | $successMessage = 'Staging site successfully updated'; |
| 76 | WPStaging::make(AnalyticsStagingUpdate::class)->enqueueFinishEvent($this->options->jobIdentifier, $this->options); |
| 77 | break; |
| 78 | case Job::RESET: |
| 79 | $processType = EventLoggerConst::PROCESS_PREFIX_CLONE_RESET; |
| 80 | $successMessage = 'Staging site successfully reset'; |
| 81 | WPStaging::make(AnalyticsStagingReset::class)->enqueueFinishEvent($this->options->jobIdentifier, $this->options); |
| 82 | break; |
| 83 | } |
| 84 | |
| 85 | do_action(StagingSiteCreate::ACTION_CLONING_COMPLETE, $this->options); |
| 86 | |
| 87 | $this->logger->info("✓ " . $successMessage); |
| 88 | $this->logCloneCompleted($processType); |
| 89 | return (object) $return; |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Delete Cache Files |
| 94 | * @throws \Exception |
| 95 | */ |
| 96 | protected function deleteCacheFiles() |
| 97 | { |
| 98 | $this->log("Finish: Deleting clone job's cache files..."); |
| 99 | |
| 100 | $this->cloneOptionCache->delete(); |
| 101 | $this->filesIndexCache->delete(); |
| 102 | |
| 103 | $this->log("Finish: Clone job's cache files have been deleted!"); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Prepare clone records. Without this clone data will not get updated in Sites::STAGING_SITES_OPTION during updating process. |
| 108 | * |
| 109 | * @return bool |
| 110 | */ |
| 111 | protected function prepareCloneDataRecords() |
| 112 | { |
| 113 | // Check if clones still exist |
| 114 | $this->log("Finish: Verifying existing clones..."); |
| 115 | |
| 116 | // Clone data already exists |
| 117 | if (isset($this->options->existingClones[$this->options->clone])) { |
| 118 | if ($this->isMultisiteAndPro()) { |
| 119 | $this->options->existingClones[$this->options->clone]['url'] = $this->getDestinationUrl(); |
| 120 | } |
| 121 | |
| 122 | $this->options->existingClones[$this->options->clone]['datetime'] = time(); |
| 123 | $this->options->existingClones[$this->options->clone]['status'] = 'finished'; |
| 124 | $this->options->existingClones[$this->options->clone]['prefix'] = $this->options->prefix; |
| 125 | $this->options->existingClones[$this->options->clone]['useCustomDatabase'] = $this->isExternalDatabase(); |
| 126 | $this->options->existingClones[$this->options->clone]['isCronEnabled'] = empty($this->options->isCronEnabled) ? false : true; |
| 127 | $this->options->existingClones[$this->options->clone]['isEmailsAllowed'] = (bool) $this->options->isEmailsAllowed; |
| 128 | $this->options->existingClones[$this->options->clone]['uploadsSymlinked'] = (bool) $this->options->uploadsSymlinked; |
| 129 | $this->options->existingClones[$this->options->clone]['includedTables'] = $this->options->tables; |
| 130 | $this->options->existingClones[$this->options->clone]['excludeSizeRules'] = $this->options->excludeSizeRules; |
| 131 | $this->options->existingClones[$this->options->clone]['excludeGlobRules'] = $this->options->excludeGlobRules; |
| 132 | $this->options->existingClones[$this->options->clone]['excludedDirectories'] = $this->options->excludedDirectories; |
| 133 | $this->options->existingClones[$this->options->clone]['extraDirectories'] = $this->options->extraDirectories; |
| 134 | $this->options->existingClones[$this->options->clone]['isWooSchedulerEnabled'] = empty($this->options->isWooSchedulerEnabled) ? false : true; |
| 135 | $this->options->existingClones[$this->options->clone]['isEmailsReminderEnabled'] = empty($this->options->isEmailsReminderEnabled) ? false : true; |
| 136 | $this->options->existingClones[$this->options->clone]['isAutoUpdatePlugins'] = empty($this->options->isAutoUpdatePlugins) ? false : true; |
| 137 | update_option(Sites::STAGING_SITES_OPTION, $this->options->existingClones, false); |
| 138 | $this->log("Finish: The job finished!"); |
| 139 | return true; |
| 140 | } |
| 141 | |
| 142 | $this->log("Finish: {$this->options->clone}'s clone job's data is not in database, generating data"); |
| 143 | |
| 144 | $this->options->existingClones[$this->clone] = [ |
| 145 | "directoryName" => $this->options->cloneDirectoryName, |
| 146 | "path" => trailingslashit($this->options->destinationDir), |
| 147 | "url" => $this->getDestinationUrl(), |
| 148 | "number" => $this->options->cloneNumber, |
| 149 | "version" => WPStaging::getVersion(), |
| 150 | "status" => "finished", |
| 151 | "prefix" => $this->options->prefix, |
| 152 | "datetime" => time(), |
| 153 | "useCustomDatabase" => $this->isExternalDatabase(), |
| 154 | "databaseUser" => $this->options->databaseUser, |
| 155 | "databasePassword" => $this->options->databasePassword, |
| 156 | "databaseDatabase" => $this->options->databaseDatabase, |
| 157 | "databaseServer" => $this->options->databaseServer, |
| 158 | "databasePrefix" => $this->options->databasePrefix, |
| 159 | "databaseSsl" => (bool)$this->options->databaseSsl, |
| 160 | "isEmailsAllowed" => (bool) $this->options->isEmailsAllowed, |
| 161 | "uploadsSymlinked" => (bool) $this->options->uploadsSymlinked, |
| 162 | "includedTables" => $this->options->tables, |
| 163 | "excludeSizeRules" => $this->options->excludeSizeRules, |
| 164 | "excludeGlobRules" => $this->options->excludeGlobRules, |
| 165 | "excludedDirectories" => $this->options->excludedDirectories, |
| 166 | "extraDirectories" => $this->options->extraDirectories, |
| 167 | "networkClone" => $this->isNetworkClone(), |
| 168 | ]; |
| 169 | |
| 170 | if (update_option(Sites::STAGING_SITES_OPTION, $this->options->existingClones) === false) { |
| 171 | $this->log("Finish: Failed to save {$this->options->clone}'s clone job data to database'"); |
| 172 | return false; |
| 173 | } |
| 174 | |
| 175 | return true; |
| 176 | } |
| 177 | |
| 178 | /** |
| 179 | * Get destination Hostname depending on whether WP has been installed in sub dir or not |
| 180 | * @return string |
| 181 | */ |
| 182 | private function getDestinationUrl() |
| 183 | { |
| 184 | if (!empty($this->options->cloneHostname)) { |
| 185 | return $this->options->cloneHostname; |
| 186 | } |
| 187 | |
| 188 | // if this is single site |
| 189 | if (!$this->isMultisiteAndPro()) { |
| 190 | return trailingslashit(get_site_url()) . $this->options->cloneDirectoryName; |
| 191 | } |
| 192 | |
| 193 | // The relative path to the main multisite without appending a trailingslash e.g. wordpress |
| 194 | $multisitePath = defined('PATH_CURRENT_SITE') ? PATH_CURRENT_SITE : '/'; |
| 195 | return rtrim($this->urls->getBaseUrl(), '/\\') . $multisitePath . $this->options->cloneDirectoryName; |
| 196 | } |
| 197 | } |
| 198 |