How To: Create Add-on Upgrade Package¶

namespace Tygh\UpgradeCenter\Connectors\Upgrade;// "Upgrage" - is an add-on name.
                                                                                                // If your add-on has "my_changes" name, so namespace will look like:  ygh\UpgradeCenter\MyChanges
use Tygh\UpgradeCenter\Connectors\IConnector as UCInterface;

/**
 * Core upgrade connector interface
 */
class Connector implements UCInterface
{
    /**
     * Prepares request data for request to Upgrade server (Check for the new upgrades)
     *
     * @return array Prepared request information
     */
    public function getConnectionData()
    {
    }

    /**
     * Processes the response from the Upgrade server.
     *
     * @param  string $response              server response
     * @param  bool   $show_upgrade_notice internal flag, that allows/disallows Connector displays upgrade notice (A new version of [product] available)
     * @return array  Upgrade package information or empty array if upgrade is not available
     */
    public function processServerResponse($response, $show_upgrade_notice)
    {
    }

    /**
     * Downloads upgrade package from the Upgade server
     *
     * @param  array  $schema       Package schema
     * @param  string $package_path Path where the upgrade pack must be saved
     * @return bool   True if upgrade package was successfully downloaded, false otherwise
     */
    public function downloadPackage($schema, $package_path)
    {
    }
}

class Connector implements UCInterface
{
  protected $settings = array();

  public function __construct()
  {
      // Initial settings
      $addon_scheme = SchemesManager::getScheme('upgrade');

      $this->settings = array(
          'upgrade_server' => 'http://demo.cs-cart.com/index.php',
          'addon_version' => $addon_scheme->getVersion()
      );
  }
  // Other code
}

public function getConnectionData()
{
    $request_data = array(
        'method' => 'get',
        'url' => $this->settings['upgrade_server'], // We specified this setting before in the __construct method
        'data' => array(
            'dispatch' => 'updates.check',
            'product_version' => PRODUCT_VERSION,
            'edition' => PRODUCT_EDITION,
            'product_build' => PRODUCT_BUILD,
            'lang' => CART_LANGUAGE,
            'addon_version' => $this->settings['addon_version'],
            'some_custom_field' => TIME,
            'hello' => 'world',
            'super_secure_hash' => sha1(time()),
        ),
        'headers' => array(
            'Content-type: text/xml'
        )
    );

    return $request_data;
}

<?xml version="1.0"?>
<upgrade>
    <available>Y</available>
    <package>
        <file>upgrade_from_1.1_to_1.2.tgz</file>
        <name>Upgrade for the "Upgrade add-on" (from 1.1 to 1.2)</name>
        <description>New version of the addon!

            Changelog:
            - PHP warning was displayed when calculating cart. Fixed.
            - Taxes no longer available</description>
        <from_version>1.1</from_version>
        <to_version>1.2</to_version>
        <timestamp>1412366886</timestamp>
        <size>18123</size>
        <custom_field>Hello CS-Cart</custom_field>
        <my_sha_key>123</my_sha_key>
    </package>
</upgrade>

$parsed_data = array();
$data = simplexml_load_string($response);

if ((string) $data->available == 'Y') {
    $parsed_data = array(
        'file' => (string) $data->package->file, // Required field
        'name' => (string) $data->package->name, // Required field
        'description' => (string) $data->package->description, // Required field
        'from_version' => (string) $data->package->from_version, // Required field
        'to_version' => (string) $data->package->to_version, // Required field
        'timestamp' => (int) $data->package->timestamp, // Required field
        'size' => (int) $data->package->size, // Required field, size in bytes
        'my_very_important_field' => (string) $data->package->my_sha_key,
        'custom_field' => (string) $data->package->custom_field,
    );

    if ($show_upgrade_notice) {
        fn_set_notification('W', __('notice'), __('text_upgrade_available', array(
            '[product]' => 'Upgade add-on',
            '[link]' => fn_url('upgrade_center.manage')
        )), 'S');
    }
}

return $parsed_data;

return array(true, '');
return array(false, __('sha_key_is_invalid'));

public function downloadPackage($schema, $package_path)
{
    // Make some custom validation
    if ($schema['my_very_important_field'] == '123' && !empty($schema['custom_field'])) {
        $url_data = fn_get_url_data($this->settings['upgrade_server'] . '?dispatch=download&from_version=' . $schema['from_version']);

        if (!empty($url_data)) {
            $result = fn_copy($url_data['path'], $package_path);
        } else {
            $result = false;
        }
        $message = $result ? '' : __('failed');

        return array($result, $message);
    } else {
        return array(false, __('sha_key_is_invalid'));
    }
}

--- languages/
+-- migrations/
+-- package/
+-- package.json
L-- validators/

+-- package
|   L-- app
|       L-- addons
|           L-- upgrade
|               +-- addon.xml
|               +-- config.php
|               L-- func.php

+-- languages
|   L-- en
|       L-- core.po

msgid ""
msgstr "Project-Id-Version: tygh"
"Content-Type: text/plain; charset=UTF-8\n"
"Language-Team: English\n"
"Language: en_US"

msgctxt "Languages::new_language_variable"
msgid "Upgrade completed"
msgstr "Upgrade completed"

msgctxt "Addons::name::upgrade"
msgid "Demo upgrade add-on v1.2"
msgstr "Demo upgrade add-on v1.2"

msgctxt "Addons::description::upgrade"
msgid "This is description of the upgraded addon v1.2"
msgstr "This is description of the upgraded addon v1.2"

L-- validators
    L-- CheckFileValidator.php

namespace Tygh\UpgradeCenter\Validators;

use Tygh\Registry;

/**
 * Upgrade validators: Check collisions
 */
class CheckFileValidator implements IValidator
{
    /**
     * Global App config
     *
     * @var array $config
     */
    protected $config = array();

    /**
     * Validator identifier
     *
     * @var array $name ID
     */
    protected $name = 'Demo upgrade: File checker';

    /**
     * Validate specified data by schema
     *
     * @param  array $schema  Incoming validator schema
     * @param  array $request Request data
     * @return array Validation result and Data to be displayed
     */
    public function check($schema, $request)
    {
        $file_to_be_created = $this->config['dir']['root'] . '/robots.txt';

        if (!file_exists($file_to_be_created)) {
            return array(false, 'Create <strong>' . $file_to_be_created . '</strong> file first to continue upgrade');
        } else {
            return array(true, '');
        }
    }

    /**
     * Gets validator name (ID)
     *
     * @return string Name
     */
    public function getName()
    {
        return $this->name;
    }

    public function __construct()
    {
        $this->config = Registry::get('config');
    }
}