<?php
/**
 * File: class-boldgrid-backup-admin-archive.php
 *
 * @link       https://www.boldgrid.com
 * @since      1.5.3
 *
 * @package    Boldgrid_Backup
 * @subpackage Boldgrid_Backup/cron
 * @copyright  BoldGrid
 * @version    $Id$
 * @author     BoldGrid <support@boldgrid.com>
 */

/**
 * Class: Boldgrid_Backup_Admin_Archive
 *
 * @since 1.5.3
 */
class Boldgrid_Backup_Admin_Archive {
	/**
	 * The core class object.
	 *
	 * @since  1.5.3
	 * @access private
	 * @var    Boldgrid_Backup_Admin_Core
	 */
	private $core;

	/**
	 * The basename of this archive.
	 *
	 * IE if we are looking at "backup-1234.zip", the basename is "backup-1234".
	 *
	 * @since SINCEVERSION
	 * @var   string
	 */
	public $basename;

	/**
	 * Compressor used when creating archive.
	 *
	 * @since  1.6.0
	 * @access public
	 * @var    string
	 */
	public $compressor = null;

	/**
	 * Filename of this archive.
	 *
	 * @since  1.6.0
	 * @access public
	 * @var    string
	 */
	public $filename = null;

	/**
	 * Full filepath to the archive.
	 *
	 * Set in the init method.
	 *
	 * @since  1.5.3
	 * @access public
	 * @var    string
	 */
	public $filepath = null;

	/**
	 * Whether or not this is a virtual archive.
	 *
	 * A "virtual archive" is an empty archive, like
	 * backup-1234.zip
	 * That actually refers to a folder, like
	 * backup-1234/
	 *
	 * @since SINCEVERSION
	 * @var bool
	 */
	public $is_virtual;

	/**
	 * The contents of the archive's log file.
	 *
	 * @since  1.6.0
	 * @access public
	 * @var    array
	 */
	public $log = array();

	/**
	 * The filename of this archive's log file.
	 *
	 * @since  1.6.0
	 * @access public
	 * @var    string
	 */
	public $log_filename = null;

	/**
	 * The filepath to this archive's log file.
	 *
	 * @since  1.6.0
	 * @access public
	 * @var    string
	 */
	public $log_filepath = null;

	/**
	 * The unix timestamp of the backup file.
	 *
	 * The timestamp of when the backup was created. This value is set in the self::init() method by
	 * reading the 'lastmodunix' value from the logs. The 'lastmodunix' value was saved to the archive's
	 * log when the archive was made in Boldgrid_Backup_Admin_Core::archive_files().
	 *
	 * @since 1.7.3
	 * @var string
	 */
	public $timestamp = 0;

	/**
	 * URL to the details page of this backup.
	 *
	 * This property is available after calling init().
	 *
	 * @since  1.6.0
	 * @access protected
	 * @var    string
	 */
	public $view_details_url = '';

	/**
	 * @var \Boldgrid\Backup\V2\Archive\Archive
	 */
	public $virtual;

	/**
	 * Archive id.
	 *
	 * The archive id is the archive's id as found in the boldgrid_backup_backups option.
	 *
	 * This class includes the self::set_id() method to set the actual id, but this class doesn't actually
	 * call that method to set the id. The id is generally set within Boldgrid\Backup\Archive\Factory.
	 *
	 * @since SINCEVERSION
	 * @access private
	 * @var int
	 *
	 * @see Boldgrid\Backup\Archive\Option for more information about the boldgrid_backup_backups option.
	 */
	private $id;

	/**
	 * The archive key.
	 *
	 * When retrieving a list of archives, you'll get an array, and this is the archives location in
	 * the array.
	 *
	 * @since SINCEVERSION
	 * @access private
	 * @var int
	 *
	 * @see self::init() To see this property initialized.
	 */
	private $key;

	/**
	 * Constructor.
	 *
	 * @since 1.5.3
	 *
	 * @param Boldgrid_Backup_Admin_Core $core Core class object.
	 */
	public function __construct( $core = null ) {
		if ( empty( $core ) ) {
			$core = apply_filters( 'boldgrid_backup_get_core', null );
		}

		$this->core = $core;
	}

	/**
	 * Delete an archive file.
	 *
	 * @since 1.5.3
	 *
	 * @param  string $filepath Absolute path to a backup file.
	 * @return bool
	 */
	public function delete( $filepath ) {
		// Delete the .zip.
		$deleted = $this->core->wp_filesystem->delete( $filepath, false, 'f' );

		// Delete the .log.
		$this->core->archive_log->delete_by_zip( $filepath );

		/*
		 * Delete the folder.
		 *
		 * Introduced in SINCEVERSION - virtual backups.
		 */
		$folder_path = \Boldgrid\Backup\Utility\Virtual_Folder::folder_by_zip( $filepath );
		if ( $this->core->wp_filesystem->exists( $folder_path ) ) {
			$this->core->wp_filesystem->delete( $folder_path, true, 'd' );
		}

		return $deleted;
	}

	/**
	 * Get an attribute from the log.
	 *
	 * @since 1.7.0
	 *
	 * @param  string $key Attributes are key / value pairs.
	 * @return mixed
	 */
	public function get_attribute( $key ) {
		return ! empty( $this->log[ $key ] ) ? $this->log[ $key ] : null;
	}

	/**
	 * Get an archive by name.
	 *
	 * Please see @return for more information on what an archive actually is.
	 *
	 * @since 1.6.0
	 *
	 * @param  string $filename Filename.
	 * @return array {
	 *     Details about an archive.
	 *
	 *     @type string $filepath    /home/user/boldgrid_backup/file.zip
	 *     @type string $filename    file.zip
	 *     @type string $filedate    1/2/2018 1:21 PM
	 *     @type int    $filesize    99152247
	 *     @type int    $lastmodunix 1514917311
	 *     @type int    $key         0
	 * }
	 */
	public function get_by_name( $filename ) {
		$return_archive = false;

		$archives = $this->core->get_archive_list();

		foreach ( $archives as $key => $archive ) {
			if ( $archive['filename'] === $filename ) {
				$archive['key'] = $key;
				$return_archive = $archive;
				break;
			}
		}

		return $return_archive;
	}

	/**
	 * Get one file from an archive.
	 *
	 * @since 1.5.3
	 *
	 * @param  string $file      The file to get.
	 * @param  bool   $meta_only Whether to include the content of the file.
	 * @return array
	 */
	public function get_file( $file, $meta_only = false ) {
		if ( empty( $this->filepath ) || ! $this->is_archive( $this->filepath ) ) {
			return false;
		}

		$zip = new Boldgrid_Backup_Admin_Compressor_Pcl_Zip( $this->core );

		$file_contents = $zip->get_file( $this->filepath, $file );

		// If we only want the meta data, unset the content of the file.
		if ( $meta_only && ! empty( $file_contents[0]['content'] ) ) {
			unset( $file_contents[0]['content'] );
		}

		return $file_contents;
	}

	/**
	 * Get the database dump file from an archive.
	 *
	 * @since 1.12.0
	 *
	 * @param  string $file      The file to get.
	 * @return array
	 */
	public function get_dump_file( $file ) {
		/**
		 * Handle encryption.
		 *
		 * @since 1.12.0
		 */
		return apply_filters( 'boldgrid_backup_post_get_dump_file', $this->get_file( $file ) );
	}

	/**
	 * Get the filesize of the backup file itself.
	 *
	 * IE the size of the zip file, not the size of everything before compression.
	 *
	 * @since 1.11.0
	 */
	public function get_filesize() {
		if ( $this->is_virtual ) {
			return get_dirsize( $this->core->backup_dir->get_path_to( $this->basename ) );
		} else {
			return $this->core->wp_filesystem->size( $this->filepath );
		}
	}

	/**
	 * Get the archive id.
	 *
	 * @since SINCEVERSION
	 *
	 * @return int
	 */
	public function get_id() {
		return $this->id;
	}

	/**
	 * Get the index of this backup.
	 *
	 * @since SINCEVERSION
	 *
	 * @return mixed Int on success, false on failure.
	 */
	public function get_index() {
		$index = null;

		$indexes = $this->core->backup_dir->get_indexed_backups();

		foreach ( $indexes as $key => $filename ) {
			if ( $filename === $this->filename ) {
				$index = $key;
				break;
			}
		}

		return $index;

	}

	/**
	 * Get the archive key.
	 *
	 * @since SINCEVERSION
	 *
	 * @return int
	 */
	public function get_key() {
		return $this->key;
	}

	/**
	 * Init.
	 *
	 * @since 1.6.0
	 *
	 * @param string $filepath File path.
	 */
	public function init( $filepath ) {
		$filepath = strip_tags( $filepath );

		if ( ! empty( $this->filepath ) && $filepath === $this->filepath ) {
			return;
		}

		$this->reset();

		$this->filepath = $filepath;
		$this->filename = basename( $this->filepath );

		$this->basename   = wp_basename( $this->filename, '.zip' );
		$this->is_virtual = $this->core->backup_dir->exists( $this->basename );
		if ( $this->is_virtual ) {
			$this->virtual = \Boldgrid\Backup\V2\Archive\Factory::run_by_filename( $this->filename );
		}

		$this->log_filepath = $this->core->archive_log->path_from_zip( $this->filepath );
		$this->log_filename = basename( $this->log_filepath );

		// If the archive's log file does not exist, extract it.
		$have_log = $this->core->wp_filesystem->exists( $this->log_filepath );
		if ( ! $have_log ) {
			$have_log = $this->core->archive_log->restore_by_zip( $this->filepath );
		}

		if ( $have_log ) {
			$this->log = $this->core->archive_log->get_by_zip( $this->filepath );

			$this->timestamp = empty( $this->log['lastmodunix'] ) ? 0 : $this->log['lastmodunix'];
		}

		/*
		 * Init our compressor.
		 *
		 * If there is no log file, this archive was created with version < 1.6
		 * and the only compressor was ZipArchive.
		 */
		$this->compressor = ! empty( $this->log['compressor'] ) ? $this->log['compressor'] : 'php_zip';

		$this->view_details_url = admin_url( 'admin.php?page=boldgrid-backup-archive-details&filename=' . $this->filename );

		$this->key = $this->get_index();
	}

	/**
	 * Init an archive based on filename.
	 *
	 * This method's init() function requires a full filepath. This method is a helper function that
	 * inits based on filename instead.
	 *
	 * @since 1.7.3
	 *
	 * @param string $filename Filename.
	 */
	public function init_by_filename( $filename ) {
		$filepath = $this->core->backup_dir->get_path_to( $filename );

		$this->init( $filepath );
	}

	/**
	 * Init this class based upon an archive key.
	 *
	 * @since 1.11.0
	 *
	 * @param  int $key The archive key.
	 * @return bool     Whether or not this archive was initialized successfully.
	 */
	public function init_by_key( $key ) {
		$this->reset();

		$archives = $this->core->get_archive_list();

		if ( empty( $archives[ $key ] ) ) {
			return false;
		}

		$archive = $archives[ $key ];

		if ( ! empty( $archive['filename'] ) ) {
			$this->init_by_filename( $archive['filename'] );
		}

		/*
		 * Return whether or not this init method was successful. If we don't have a filename, then
		 * it was not succesful.
		 */
		return ! empty( $this->filename );
	}

	/**
	 * Init this class using the last backup created.
	 *
	 * The last backup created is that defined by the boldgrid_backup_latest_backup option. This option
	 * is set at the end of Boldgrid_Backup_Admin_Core::archive_files.
	 */
	public function init_by_latest() {
		$option = get_option( 'boldgrid_backup_latest_backup' );

		if ( ! empty( $option['filepath'] ) ) {
			$this->init( $option['filepath'] );
		}
	}

	/**
	 * Determine if a zip file is in our archive.
	 *
	 * @since 1.5.3
	 *
	 * @param  string $filepath File path.
	 * @return bool
	 */
	public function is_archive( $filepath ) {
		$is_archive = false;
		$basename   = wp_basename( $filepath );
		$archives   = $this->core->backup_dir->get_indexed_backups();

		foreach ( $archives as $archive ) {
			if ( $basename === $archive ) {
				$is_archive = true;
				break;
			}
		}

		return $is_archive;
	}

	/**
	 * Determine if a backup belongs to this site.
	 *
	 * This method takes into account a site's $backup_identifier and compares
	 * it to a backup's filename.
	 *
	 * @since 1.6.0
	 *
	 * @param  string $filename Filename.
	 * @return bool
	 */
	public function is_site_archive( $filename ) {
		$backup_identifier = $this->core->get_backup_identifier();

		// End in zip.
		$extension = pathinfo( $filename, PATHINFO_EXTENSION );
		if ( 'zip' !== $extension ) {
			return false;
		}

		// Include the backup identifier.
		if ( false === strpos( $filename, $backup_identifier ) ) {
			return false;
		}

		// Begin with 'boldgrid-backup-'.
		if ( 0 !== strpos( $filename, 'boldgrid-backup-' ) ) {
			return false;
		}

		return true;
	}

	/**
	 * Determine whether or not this archive is stored on the web server (local).
	 *
	 * This is similar to self::is_stored_remotely. While that method is an
	 * expensive operation, this one is not. However, for consistency, this too
	 * will be a method rather than a class property.
	 *
	 * @since 1.6.0
	 *
	 * @return bool
	 */
	public function is_stored_locally() {
		$this->core->archives_all->init();

		return isset( $this->core->archives_all->archives[ $this->filename ]['on_web_server'] ) &&
			true === $this->core->archives_all->archives[ $this->filename ]['on_web_server'];
	}

	/**
	 * Determine whether or not this archive is stored remotely somewhere.
	 *
	 * This is an expensive operation, so we are not using this as a class
	 * property / initializing during init.
	 *
	 * @since 1.6.0
	 *
	 * @return bool
	 */
	public function is_stored_remotely() {
		$this->core->archives_all->init();

		return isset( $this->core->archives_all->archives[ $this->filename ]['on_remote_server'] ) &&
			true === $this->core->archives_all->archives[ $this->filename ]['on_remote_server'];
	}

	/**
	 * Reset this class.
	 *
	 * @since 1.6.0
	 */
	public function reset() {
		$this->filename     = null;
		$this->filepath     = null;
		$this->log_filepath = null;
		$this->log_filename = null;
		$this->log          = array();
		$this->compressor   = null;

		// Virtual.
		$this->is_virtual = null;
		$this->virtual    = null;
	}

	/**
	 * Set an attribute in the log.
	 *
	 * @since 1.7.0
	 *
	 * @param  string $key   The key.
	 * @param  string $value The value.
	 * @return bool
	 */
	public function set_attribute( $key, $value ) {
		$old_value = isset( $this->log[ $key ] ) ? $this->log[ $key ] : null;

		// If the value is not changing, then return success.
		if ( $value === $old_value ) {
			return true;
		}

		/**
		 * Filter archive attribute value.
		 *
		 * Allows operations to be performed on attribute changes and alter the value depending on results.
		 *
		 * @since 1.12.2
		 *
		 * @param  string $value     New value.
		 * @param  string $old_value Old value.
		 * @param  string $key       Key name.
		 * @param  string $filepath  Archive filepath.
		 * @return string
		 */
		$value = apply_filters( 'boldgrid_backup_archive_update_attribute', $value, $old_value, $key, $this->filepath );

		$this->log[ $key ] = $value;

		return $this->core->archive_log->write( $this->log );
	}

	/**
	 * Set the archive id.
	 *
	 * @since SINCEVERSION
	 *
	 * @param int $id The archive id.
	 */
	public function set_id( $id ) {
		$this->id = (int) $id;
	}

	/**
	 * Update an archive's timestamp based on the time in the log.
	 *
	 * For example, if the archive was created at 10am and you uploaded it to
	 * an FTP server at 12pm, the FTP server may set the timestamp to 12pm. Then
	 * you download from FTP to web server at 2pm, and the archive's timestamp
	 * is now 2pm. This is all confusing. This method will get the archive's
	 * timestamp from the log and configure the last modified appropriately.
	 */
	public function update_timestamp() {
		// If we don't have what we need, abort.
		if ( empty( $this->filepath ) || empty( $this->log['lastmodunix'] ) ) {
			return false;
		}

		return $this->core->wp_filesystem->touch( $this->filepath, $this->log['lastmodunix'] );
	}

	/**
	 * Validate a download link request.
	 *
	 * @since 1.7.0
	 *
	 * @see Boldgrid_Backup_Admin_Archive::get_by_name()
	 *
	 * @param  string $filename Filename.
	 * @return array
	 */
	public function validate_link_request( $filename ) {
		$result['is_valid'] = true;

		// Verify access permissions.
		if ( ! current_user_can( 'update_plugins' ) ) {
			$result['errors'][] = __( 'Insufficient permission', 'boldgrid-backup' );
		}

		// Validate archive filename.
		if ( empty( $filename ) ) {
			$result['errors'][] = __( 'Invalid archive filename', 'boldgrid-backup' );
		}

		// Check WP_Filesystem method; ensure it is "direct".
		if ( 'direct' !== get_filesystem_method() ) {
			$result['errors'][] = __(
				'Filesystem access method is not "direct"',
				'boldgrid-backup'
			);
		}

		// Get archive details.
		$archive = $this->get_by_name( $filename );

		// Check if archive file was found.
		if ( empty( $archive ) ) {
			$result['errors'][] = __( 'Archive file not found', 'boldgrid-backup' );
		}

		$expires = strtotime( '+' . $this->core->configs['public_link_lifetime'] );

		if ( ! $expires || $expires < time() ) {
			$result['errors'][] = __(
				'Invalid "public_link_lifetime" configuration setting',
				'boldgrid-backup'
			);
		}

		if ( ! empty( $result['errors'] ) ) {
			$result['is_valid'] = false;
		}

		return $result;
	}

	/**
	 * Generate a public link to download an archive file.
	 *
	 * The link is only valid for a limited time, which is configurable in a configuration file.
	 *
	 * @since 1.7.0
	 *
	 * @see Boldgrid_Backup_Admin_Archive::validate_link_request()
	 * @see Boldgrid_Backup_Authentication::create_token()
	 *
	 * @param  string $filename Filename.
	 * @return string
	 */
	public function generate_download_link( $filename ) {
		$validation_results = $this->validate_link_request( $filename );

		if ( $validation_results['is_valid'] ) {
			// Initialize this backup so we have access to properties (like is_virtual).
			$this->init_by_filename( $filename );

			$expires = strtotime( '+' . $this->core->configs['public_link_lifetime'] );
			$token   = Boldgrid_Backup_Authentication::create_token( $filename, $expires );
			$type    = $this->is_virtual ? 'many' : 'one';

			$response['download_url'] = get_site_url(
				null,
				'wp-admin/admin-ajax.php?action=boldgrid_backup_download&t=' . $token . '&type=' . $type
			);

			$response['expires_when'] = human_time_diff(
				$expires,
				current_time( 'timestamp', true )
			);
		} else {
			$response['error'] = implode( '<br />', $validation_results['errors'] );
		}

		return $response;
	}

	/**
	 * Save backup information to a JSON file.
	 *
	 * The emergency restoration process will read the JSON file to discover the information about
	 * the last full backup created.  Since the standalone restoration process does not know about
	 * the WordPress installation or the backup archives created, the contents of this file created
	 * will provide the facts.
	 * This method is called by Boldgrid_Backup_Admin_Core::archive_files().
	 *
	 * @since 1.8.0
	 *
	 * @see Boldgrid_Backup_Admin_Backup_Dir::get()
	 * @see Boldgrid_Backup_Admin_Cron::get_cron_secret()
	 * @see Boldgrid_Backup_Admin_Core::archive_files()
	 *
	 * @param  array $info {
	 *     An array of info about the backup just created.
	 *
	 *     @type string $mode         backup
	 *     @type bool   $dryrun
	 *     @type string $compressor   pcl_zip
	 *     @type int    $filesize     30992482
	 *     @type bool   $save
	 *     @type int    $total_size
	 *     @type string $filepath     C:\file.zip
	 *     @type int    $lastmodunix  1506602959
	 *     @type int    $duration     57.08
	 *     @type int    $db_duration  0.35
	 *     @type bool   $mail_success
	 * }
	 * @return bool
	 */
	public function write_results_file( $info ) {
		$success          = false;
		$archive_filepath = ! empty( $info['filepath'] ) ? $info['filepath'] : null;
		$results_filepath = \Boldgrid\Backup\Cli\Info::get_results_filepath();
		$is_dir_writable  = $this->core->wp_filesystem->is_writable( dirname( $results_filepath ) );

		if ( $archive_filepath && $is_dir_writable ) {
			$results_filepath = wp_normalize_path( $results_filepath );
			$archive_filename = basename( $archive_filepath );
			$archive_info     = $this->core->archive->get_by_name( $archive_filename );
			$archive_key      = isset( $archive_info['key'] ) ? $archive_info['key'] : null;
			$encrypt_db       = ! empty( $archive_info['encrypt_db'] );
			$encrypt_sig      = isset( $archive_info['encrypt_sig'] ) ? $archive_info['encrypt_sig'] : null;
			$cron_secret      = $this->core->cron->get_cron_secret();
			$siteurl          = site_url();
			$site_title       = get_bloginfo( 'name' );
			$restore_cmd      = http_build_query(
				[
					'mode'             => 'restore',
					'siteurl'          => $siteurl,
					'id'               => $this->core->get_backup_identifier(),
					'secret'           => $cron_secret,
					'archive_key'      => $archive_key,
					'archive_filename' => $archive_filename,
					'site_title'       => $site_title,
				],
				'',
				' '
			);

			$results = array(
				'ABSPATH'     => ABSPATH,
				'archive_key' => $archive_key,
				'cron_secret' => $cron_secret,
				'filepath'    => $archive_filepath,
				'siteurl'     => $siteurl,
				'site_title'  => $site_title,
				'restore_cmd' => $this->core->cron->get_cron_command() . ' "' . dirname( __DIR__ ) .
					'/boldgrid-backup-cron.php" ' . $restore_cmd,
				'timestamp'   => time(),
			);

			$success = $this->core->wp_filesystem->put_contents(
				$results_filepath,
				wp_json_encode( $results ),
				0600
			);
		}

		return $success;
	}

	/**
	 * Delete a file from an archive.
	 *
	 * @since 1.12.0
	 *
	 * @param \PclZip $archive  PCLZip achive object.
	 * @param string  $filename Filename to delete.
	 * @param array   $list     Content list from the archive object.
	 */
	public function delete_from_archive( &$archive, $filename, $list = null ) {
		if ( is_a( $archive, '\PclZip' ) && empty( $list ) ) {
			$list = $archive->listContent();
		}

		if ( is_a( $archive, '\PclZip' ) && ! empty( $filename ) && ! empty( $list ) ) {
			foreach ( $list as $index => $filedata ) {
				if ( $filename === $filedata['filename'] ) {
					$remaining = $archive->deleteByIndex( $index );

					if ( ! empty( $remaining[1] ) ) {
						$this->delete_from_archive( $archive, $filename, $remaining );
					}
				}
			}
		}
	}
}
