first commit

administrator/components/com_akeebabackup/engine/Platform/Exception/DecryptionException.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Platform\Exception;
+
+defined('AKEEBAENGINE') || die();
+
+use Akeeba\Engine\Platform;
+use Exception;
+use RuntimeException;
+
+/**
+ * Thrown when the settings cannot be decrypted, e.g. when the server no longer has encyrption enabled or the key has
+ * changed.
+ */
+class DecryptionException extends RuntimeException
+{
+	public function __construct($message = null, $code = 500, Exception $previous = null)
+	{
+		if (empty($message))
+		{
+			$message = Platform::getInstance()->translate('COM_AKEEBA_CONFIG_ERR_DECRYPTION');
+		}
+
+		parent::__construct($message, $code, $previous);
+	}
+
+}

administrator/components/com_akeebabackup/engine/Platform/PlatformInterface.php

@@ -0,0 +1,413 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Platform;
+
+defined('AKEEBAENGINE') || die();
+
+use Exception;
+
+/**
+ * Interface PlatformInterface
+ *
+ * @property string $tableNameProfiles The name of the table where backup profiles are stored
+ * @property string $tableNameStats    The name of the table where backup records are stored
+ * @property array  $configOverrides   Configuration overrides
+ */
+interface PlatformInterface
+{
+	/**
+	 * Returns an array with the directory/-ies in which the magic autoloader should look for platform overrides.
+	 *
+	 * @return  array
+	 */
+	public function getPlatformDirectories();
+
+	/**
+	 * Performs heuristics to determine if this platform object is the ideal
+	 * candidate for the environment Akeeba Engine is running in.
+	 *
+	 * @return  bool
+	 */
+	public function isThisPlatform();
+
+	/**
+	 * Saves the current configuration to the database table
+	 *
+	 * @param   int  $profile_id      The profile where to save the configuration
+	 *                                to, defaults to current profile
+	 *
+	 * @return  bool  True if everything was saved properly
+	 */
+	public function save_configuration($profile_id = null);
+
+	/**
+	 * Loads the current configuration off the database table
+	 *
+	 * @param   int  $profile_id  The profile where to read the configuration from, defaults to current profile
+	 *
+	 * @return  bool  True if everything was read properly
+	 */
+	public function load_configuration($profile_id = null);
+
+	/**
+	 * Returns an associative array of stock platform directories
+	 *
+	 * @return  array
+	 */
+	public function get_stock_directories();
+
+	/**
+	 * Returns the absolute path to the site's root
+	 *
+	 * @return  string
+	 */
+	public function get_site_root();
+
+	/**
+	 * Returns the absolute path to the installer images directory
+	 *
+	 * @return  string
+	 */
+	public function get_installer_images_path();
+
+	/**
+	 * Returns the active profile number
+	 *
+	 * @return  integer
+	 */
+	public function get_active_profile();
+
+	/**
+	 * Returns the selected profile's name. If no ID is specified, the current
+	 * profile's name is returned.
+	 *
+	 * @param   integer|null  $id  The ID of the profile, skip for current profile
+	 *
+	 * @return  string
+	 */
+	public function get_profile_name($id = null);
+
+	/**
+	 * Returns the backup origin
+	 *
+	 * @return  string  Backup origin: backend|frontend
+	 */
+	public function get_backup_origin();
+
+	/**
+	 * Returns a timestamp formatted for the current site's database driver
+	 *
+	 * @param   string  $date  [optional] The timestamp to use. Omit to use current timestamp.
+	 *
+	 * @return  string
+	 */
+	public function get_timestamp_database($date = 'now');
+
+	/**
+	 * Returns the current timestamp, taking into account any TZ information,
+	 * in the format specified by $format.
+	 *
+	 * @param   string  $format  Timestamp format string (standard PHP format string)
+	 *
+	 * @return  string
+	 */
+	public function get_local_timestamp($format);
+
+	/**
+	 * Returns the current host name
+	 *
+	 * @return  string
+	 */
+	public function get_host();
+
+	/**
+	 * Returns the current site's name
+	 *
+	 * @return  string
+	 */
+	public function get_site_name();
+
+	/**
+	 * Creates or updates the statistics record of the current backup attempt
+	 *
+	 * @param   int    $id    Backup record ID, use null for new record
+	 * @param   array  $data  The data to store
+	 *
+	 * @return int|null The new record id, or null if this doesn't apply
+	 *
+	 * @throws Exception On database error
+	 */
+	public function set_or_update_statistics($id = null, $data = []);
+
+	/**
+	 * Loads and returns a backup statistics record as a hash array
+	 *
+	 * @param   int  $id  Backup record ID
+	 *
+	 * @return  array
+	 */
+	public function get_statistics($id);
+
+	/**
+	 * Completely removes a backup statistics record
+	 *
+	 * @param   int  $id  Backup record ID
+	 *
+	 * @return  bool  True on success
+	 */
+	public function delete_statistics($id);
+
+	/**
+	 * Returns a list of backup statistics records, respecting the pagination
+	 *
+	 * The $config array allows the following options to be set:
+	 * limitstart    int        Offset in the recordset to start from
+	 * limit        int        How many records to return at once
+	 * filters        array    An array of filters to apply to the results. Alternatively you can just pass a profile
+	 * ID to filter by that profile. order        array    Record ordering information (by and ordering)
+	 *
+	 * @param   array  $config  See above
+	 *
+	 * @return  array
+	 */
+	function &get_statistics_list($config = []);
+
+	/**
+	 * Return the total number of statistics records
+	 *
+	 * @param   array  $filters  An array of filters to apply to the results. Alternatively you can just pass a profile
+	 *                           ID to filter by that profile.
+	 *
+	 * @return  integer
+	 */
+	function get_statistics_count($filters = null);
+
+	/**
+	 * Returns an array with the specifics of running backups
+	 *
+	 * @param   string  $tag  The backup type (e.g. backend)
+	 *
+	 * @return  array
+	 */
+	public function get_running_backups($tag = null);
+
+	/**
+	 * Multiple backup attempts can share the same backup file name. Only
+	 * the last backup attempt's file is considered valid. Previous attempts
+	 * have to be deemed "obsolete". This method returns a list of backup
+	 * statistics ID's with "valid"-looking names. IT DOES NOT CHECK FOR THE
+	 * EXISTENCE OF THE BACKUP FILE!
+	 *
+	 * @param   bool    $useprofile   If true, it will only return backup records of the current profile
+	 * @param   array   $tagFilters   Which tags to include; leave blank for all. If the first item is "NOT", then all
+	 *                                tags EXCEPT those listed will be included.
+	 * @param   string  $ordering     Ordering of the records, default DESC (descending), use DESC or ASC
+	 *
+	 * @return  array    A list of ID's for records w/ "valid"-looking backup files
+	 */
+	public function &get_valid_backup_records($useprofile = false, $tagFilters = [], $ordering = 'DESC');
+
+	/**
+	 * Invalidates older records sharing the same $archivename
+	 *
+	 * @param   string  $archivename  The archive name
+	 *
+	 * @return  void
+	 */
+	public function remove_duplicate_backup_records($archivename);
+
+	/**
+	 * Marks the specified backup records as having no files
+	 *
+	 * @param   array  $ids  Array of backup record IDs to ivalidate
+	 *
+	 * @return  void
+	 */
+	public function invalidate_backup_records($ids);
+
+	/**
+	 * Gets a list of records with remotely stored files in the selected remote storage
+	 * provider and profile.
+	 *
+	 * @param   int     $profile   (optional) The profile to use. Skip or use null for active profile.
+	 * @param   string  $engine    (optional) The remote engine to looks for. Skip or use null for the active profile's
+	 *                             engine.
+	 *
+	 * @return  array
+	 */
+	public function get_valid_remote_records($profile = null, $engine = null);
+
+	/**
+	 * Returns the filter data for the entire filter group collection
+	 *
+	 * @return  array
+	 */
+	public function &load_filters();
+
+	/**
+	 * Saves the nested filter data array $filter_data to the database
+	 *
+	 * @param   array  $filter_data  The filter data to save
+	 *
+	 * @return  bool  True on success
+	 */
+	public function save_filters(&$filter_data);
+
+	/**
+	 * Gets the best matching database driver class, according to CMS settings
+	 *
+	 * @param   bool  $use_platform     If set to false, it will forcibly try to assign one of the primitive type
+	 *                                  (Mysql/Mysqli) and NEVER tell you to use an platform driver
+	 *
+	 * @return  string
+	 */
+	public function get_default_database_driver($use_platform = true);
+
+	/**
+	 * Returns a set of options to connect to the default database of the current CMS
+	 *
+	 * @return  array
+	 */
+	public function get_platform_database_options();
+
+	/**
+	 * Provides a platform-specific translation function
+	 *
+	 * @param   string  $key  The translation key
+	 *
+	 * @return  string
+	 */
+	public function translate($key);
+
+	/**
+	 * Populates global constants holding the Akeeba version
+	 *
+	 * @return  void
+	 */
+	public function load_version_defines();
+
+	/**
+	 * Returns the platform name and version
+	 *
+	 * @return  array  Contains the platform name and version
+	 */
+	public function getPlatformVersion();
+
+	/**
+	 * Logs platform-specific directories with LogLevel::INFO log level
+	 *
+	 * @return  string  If there are any extra notes / warnings on this platform
+	 */
+	public function log_platform_special_directories();
+
+	/**
+	 * Loads a platform-specific software configuration option. These are
+	 * configuration values for the backup engine, but unlike the rest of the
+	 * configuration options they are not stored in the backup profile.
+	 * Instead, these are stored globally using a platform-specific method.
+	 * So these are not configuration values for the platform itself.
+	 *
+	 * @param   string  $key      The configuration option to retrieve
+	 * @param   mixed   $default  The default value to return if it's not defined
+	 *
+	 * @return  mixed
+	 */
+	public function get_platform_configuration_option($key, $default);
+
+	/**
+	 * Returns a list of emails to the administrators
+	 *
+	 * @return  array
+	 */
+	public function get_administrator_emails();
+
+	/**
+	 * Sends a very simple email using the platform's emailer facility
+	 *
+	 * @param   string  $to          Recipient address
+	 * @param   string  $subject     Email subject line
+	 * @param   string  $body        Email body (plain text)
+	 * @param   string  $attachFile  (optional) Full path to the file being attached
+	 *
+	 * @return  bool  True on success
+	 */
+	public function send_email($to, $subject, $body, $attachFile = null);
+
+	/**
+	 * Deletes a file from the local server using direct file access or FTP
+	 *
+	 * @param   string  $file  The file to unlink
+	 *
+	 * @return  bool  True on success
+	 */
+	public function unlink($file);
+
+	/**
+	 * Moves a file around within the local server using direct file access or FTP
+	 *
+	 * @param   string  $from  Full path of the file to move
+	 * @param   string  $to    Full path of where the file will be moved to
+	 *
+	 * @return  bool  True on success
+	 */
+	public function move($from, $to);
+
+	/**
+	 * Stores a flash (temporary) variable in the session.
+	 *
+	 * @param   string  $name   The name of the variable to store
+	 * @param   string  $value  The value of the variable to store
+	 *
+	 * @return  void
+	 */
+	public function set_flash_variable($name, $value);
+
+	/**
+	 * Return the value of a flash (temporary) variable from the session and
+	 * immediately removes it.
+	 *
+	 * @param   string  $name     The name of the flash variable
+	 * @param   mixed   $default  Default value, if the variable is not defined
+	 *
+	 * @return  mixed  The value of the variable or $default if it's not set
+	 */
+	public function get_flash_variable($name, $default = null);
+
+	/**
+	 * Perform an immediate redirection to the defined URL
+	 *
+	 * @param   string  $url  The URL to redirect to
+	 *
+	 * @return  void
+	 */
+	public function redirect($url);
+
+	/**
+	 * Get the proxy configuration for this platform.
+	 *
+	 * @return  array{enabled: bool, host: string, port: int, user: string, pass: string}
+	 * @since   9.0.7
+	 */
+	public function getProxySettings();
+
+	/**
+	 * Set the proxy configuration for this platform
+	 *
+	 * @param   false   $useProxy  Should I use a proxy at all?
+	 * @param   string  $host      Proxy hostname or IP address
+	 * @param   int     $port      Proxy port
+	 * @param   string  $username  Proxy username. Optional. Leavel blank to turn off authentication.
+	 * @param   string  $password  Proxy password.
+	 *
+	 * @return  void
+	 * @since   9.0.7
+	 */
+	public function setProxySettings($useProxy = false, $host = '', $port = 8080, $username = '', $password = '');
+}