forked from zencart/zencart
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Allow downloadable files to be hosted externally, including AWS
Merges zencart#327 and zencart#347 - added support for AWS-hosted downloads (files on AWS S3) ... simply give `aws:bucketname/filename.ext` as the filename in attributes controller, with expiring links to prevent theft - added support for URL-based downloads, such as Dropbox or any other http/https URL which requires no authentication by the customer (NOTE: offers no theft prevention or download-count-tracking) - cleaned up the My Account list of downloads, for simpler styling - changed both admin and catalog to allow observers to provide details of file availability - moved download-by-redirect and download-by-streaming to observer class Notes: - If using with Dropbox, set the `&dl=0` to `&dl=1` on the "sharing link" that Dropbox gives you, so that the file is immediately downloaded for the customer. - If sharing from Google Drive, be sure to configure the Sharing Permissions properly, and obtain a shareable link that's got read-only access. Dev tip: - For AWS, to keep credentials out of version-control, put them into the `extra-configures` folder, and prefix the filename with `dev-` since that's in the project's `.gitignore` already.
- Loading branch information
Showing
11 changed files
with
958 additions
and
307 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,237 @@ | ||
| <?php | ||
| /** | ||
| * @package plugins | ||
| * @copyright Copyright 2003-2015 Zen Cart Development Team | ||
| * @license http://www.zen-cart.com/license/2_0.txt GNU Public License V2.0 | ||
| * @version $Id: Designed for v1.6.0 $ | ||
| */ | ||
|
|
||
| /** | ||
| * This observer class is intended to allow downloadable files to be served | ||
| * from Amazon AWS S3 buckets, and also automatically expire the links | ||
| * so that customers can't share them or otherwise steal the files | ||
| * | ||
| */ | ||
| class zcObserverDownloadsViaAws extends base { | ||
|
|
||
| // this is where you can configure your AWS settings: | ||
| // -------------------------------------------------- | ||
| // Alternatively, you can define them as constants in | ||
| // the extra_configures folder: AMAZON_S3_ACCESS_KEY | ||
| // and AMAZON_S3_ACCESS_SECRET | ||
| // -------------------------------------------------- | ||
| /** | ||
| * Set your Amazon AWS S3 Access Key and Secret Key here | ||
| * @var string | ||
| */ | ||
| private $aws_key = "MY_AMAZON_S3_ACCESS_KEY"; | ||
| private $aws_secret = "MY_AMAZON_S3_SECRET_XXXXXXXXX"; | ||
|
|
||
| /** | ||
| * This is used to calculate a link that's good for 30 seconds, | ||
| * which is plenty of time for it to get started, & prevents | ||
| * unauthorized sharing and theft. Default is 30 seconds. | ||
| * @var integer | ||
| */ | ||
| protected $link_expiry_time = 30; | ||
|
|
||
| /** | ||
| * Class constructor | ||
| */ | ||
| public function __construct() { | ||
| // read config from constants if available | ||
| if ($this->aws_key == 'MY_AMAZON_S3_ACCESS_KEY' && defined('AMAZON_S3_ACCESS_KEY')) $this->aws_key = AMAZON_S3_ACCESS_KEY; | ||
| if ($this->aws_secret == 'MY_AMAZON_S3_SECRET_XXXXXXXXX' && defined('AMAZON_S3_ACCESS_SECRET')) $this->aws_secret = AMAZON_S3_ACCESS_SECRET; | ||
|
|
||
| // if not configured, then don't activate | ||
| if ($this->aws_key == 'MY_AMAZON_S3_ACCESS_KEY' || $this->aws_key == '' || $this->aws_secret == '' || $this->aws_secret == 'MY_AMAZON_S3_SECRET_XXXXXXXXX') return false; | ||
|
|
||
| // attach listener | ||
| $this->attach($this, array('NOTIFY_CHECK_DOWNLOAD_HANDLER', 'NOTIFY_DOWNLOAD_READY_TO_START', 'NOTIFY_MODULE_DOWNLOAD_TEMPLATE_DETAILS', 'NOTIFY_TEST_DOWNLOADABLE_FILE_EXISTS')); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Parse the file details for display on template page | ||
| * | ||
| * @param string $eventID name of the observer event fired | ||
| * @param array $array $download->fields data | ||
| * @param array $data array passed by reference | ||
| */ | ||
| protected function updateNotifyModuleDownloadTemplateDetails(&$class, $eventID, $array, &$data) | ||
| { | ||
| // available fields: | ||
| // $data['service'] = 'local' | ||
| // $data['filename'] = db query result from orders_products_filename | ||
| // $data['expiry_timestamp'] | ||
| // $data['expiry'] | ||
| // $data['downloads_remaining'] | ||
| // $data['unlimited_downloads'] | ||
| // $data['file_exists'] = file_exists(DIR_FS_DOWNLOAD . $data['filename']); | ||
| // $data['is_downloadable'] = $data['file_exists'] && ($data['downloads_remaining'] > 0 && $data['expiry_timestamp'] > time()) || $data['unlimited_downloads']; | ||
| // $data['filesize'] = ($data['file_exists']) ? filesize(DIR_FS_DOWNLOAD . $file['orders_products_filename']) : 'Unknown'; | ||
| // $data['date_purchased_day'] | ||
| // $data['download_maxdays'] | ||
| // $data['products_name'] | ||
| // $data['orders_products_download_id'] = id for URL link | ||
| // $data['download_count'] | ||
|
|
||
| $file_parts = $this->parseFileParts($data['filename']); | ||
|
|
||
| if ($file_parts === false) return; | ||
| if ($file_parts[0] != 'aws') return; | ||
|
|
||
| $data['service'] = $file_parts[0]; | ||
|
|
||
| // use just the filename portion, skipping the bucket name for customer-facing display purposes | ||
| $data['filename'] = substr($file_parts[1], strrpos($file_parts[1], '/') + 1); | ||
|
|
||
| $data['filesize'] = isset($file_parts[2]) ? number_format($file_parts[2], 0) : ''; | ||
| $data['filesize_units'] = ''; | ||
|
|
||
| // could optionally add an AWS SDK call to actually check that the object exists | ||
| $data['is_downloadable'] = $data['file_exists'] = true; | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * This observer should set $handler to blank if it fails to validate whether $filename exists on the external service. | ||
| * If validation passes, simply set $handler to the service name (first chars before first colon in filename) (or do nothing since it's probably already correct). | ||
| * If there is no way to verify, do nothing to $handler. | ||
| * | ||
| * @param string $eventID name of the observer event fired | ||
| * @param string $filename filename to verify exists | ||
| * @param string $handler name of external service handler | ||
| */ | ||
| protected function updateNotifyTestDownloadableFileExists(&$class, $eventID, $filename, &$handler) | ||
| { | ||
| $result = $this->testFileExists($filename); | ||
|
|
||
| if ($result === false) { | ||
| $handler = ''; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * @param string $eventID name of the observer event fired | ||
| * @param array $var deprecated array, used only for backward compatibility | ||
| * @param array $fields data feeding all download activities | ||
| * @param string $origin_filename (mutable) | ||
| * @param string $browser_filename (mutable) | ||
| * @param string $source_directory (mutable) | ||
| * @param boolean $file_exists (mutable) | ||
| */ | ||
| protected function updateNotifyCheckDownloadHandler(&$class, $eventID, $var, &$fields, &$origin_filename, &$browser_filename, &$source_directory, &$file_exists, &$service, &$isExpired, &$download_timestamp) | ||
| { | ||
| // // compatibility for ZC versions older than v1.6.0: | ||
| // if (PROJECT_VERSION_MAJOR == '1' && PROJECT_DB_VERSION_MINOR < '6.0') { | ||
| // $fields = $var->fields; | ||
| // $browser_filename = $origin_filename = $fields['orders_products_filename']; | ||
| // $source_directory = DIR_FS_DOWNLOAD; | ||
| // } | ||
|
|
||
| $file_parts = $this->parseFileParts($origin_filename); | ||
| if ($file_parts[0] == 'aws') { | ||
| $origin_filename = $file_parts[1]; | ||
| $browser_filename = substr($origin_filename, strrpos($origin_filename, '/') + 1); | ||
| $source_directory = $file_parts[0]; | ||
| $file_exists = true; | ||
| $service = $file_parts[0]; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * This fires when the download module wants to redirect to the external download service | ||
| * So, this method parses the passed file, obtains the URL, and does the redirect | ||
| * | ||
| * @param string $eventID name of the observer event fired | ||
| * @param string $ipaddress customer IP | ||
| * @param string $service (mutable) | ||
| * @param string $origin_filename (mutable) | ||
| * @param string $browser_filename (mutable) | ||
| * @param string $source_directory (mutable) | ||
| * @param integer $downloadFilesize (mutable) | ||
| * @param string $mime_type (mutable) | ||
| * @param array $fields array of data from db query feeding the download page | ||
| * @param string $browser_headers (mutable) | ||
| */ | ||
| protected function updateNotifyDownloadReadyToStart(&$class, $eventID, $ipaddress, &$service, &$origin_filename, &$browser_filename, &$source_directory, &$downloadFilesize, $mime_type, $fields, $browser_headers) | ||
| { | ||
| // // compatibility for ZC versions older than v1.6.0: | ||
| // if (PROJECT_VERSION_MAJOR == '1' && PROJECT_DB_VERSION_MINOR < '6.0') { | ||
| // list($origin_filename, $browser_filename, $downloadFilesize, $ipaddress, $fields) = each($array); | ||
| // } | ||
| // if (isset($source_directory) && $source_directory != '') $this->source_directory = $source_directory; | ||
|
|
||
|
|
||
| // verify that the passed file is indeed intended for aws | ||
| if ($source_directory != 'aws') { | ||
| $file_parts = $this->parseFileParts($origin_filename); | ||
| if ($file_parts[0] != 'aws') return; | ||
| $origin_filename = $file_parts[1]; | ||
| $browser_filename = substr($origin_filename, strrpos($origin_filename, '/') + 1); | ||
| $source_directory = $file_parts[0]; | ||
| $downloadFilesize = $file_parts[2]; | ||
| } | ||
|
|
||
| // prepare AWS URL | ||
| $url = $this->buildRedirectUrl($origin_filename); | ||
|
|
||
| // redirect to external download script | ||
| header("HTTP/1.1 303 See Other"); | ||
| zen_redirect($url); | ||
|
|
||
| zen_exit(); | ||
| } | ||
|
|
||
| /** | ||
| * parse file details to determine if its download should be handled by AWS | ||
| * If AWS, the filename will use colons as delimiters ... aws:bucket/filename:filesize | ||
| * | ||
| * @param string $filename | ||
| * @return boolean|array | ||
| */ | ||
| private function parseFileParts($filename) { | ||
|
|
||
| $file_parts = explode(':', $filename); | ||
|
|
||
| if (sizeof($file_parts) == 1) return false; | ||
|
|
||
| return $file_parts; | ||
| } | ||
|
|
||
| /** | ||
| * Prepare signed expiring URL for AWS redirect | ||
| * | ||
| * @param string $bucketAndFilename | ||
| * @return string $url | ||
| */ | ||
| private function buildRedirectUrl($bucketAndFilename) { | ||
| $aws_server = "s3.amazonaws.com"; | ||
|
|
||
| // this calculates a link that's good for 30 seconds, which is plenty of time for it to get started, and prevents theft | ||
| $expires = time() + $this->link_expiry_time; | ||
|
|
||
| $raw_request = "GET\n\n\n" . $expires . "\n/" . $bucketAndFilename; | ||
| $sig = urlencode(base64_encode((hash_hmac("sha1", utf8_encode($raw_request), $this->aws_secret, true)))); | ||
|
|
||
| $params = 'AWSAccessKeyId=' . $this->aws_key . '&Expires=' . $expires . '&Signature=' . $sig; | ||
|
|
||
| return 'http://' . $aws_server . '/' . $bucketAndFilename . '?' . $params; | ||
| } | ||
|
|
||
| /** | ||
| * Use AWS SDK to test whether the bucket+file (designated by $filename) exists | ||
| * If it does not exist, return false | ||
| * | ||
| * @param string $filename | ||
| * @return boolean Result of SDK test | ||
| */ | ||
| private function testFileExists($filename) | ||
| { | ||
| //@TODO invoke AWS SDK to test whether the bucket+file exists. | ||
| return true; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.