├── .gitignore
├── src
    └── BeyondIT
    │   └── OCOK
    │       ├── Helpers
    │           ├── DummyConfig.php
    │           ├── FileSystem.php
    │           ├── Downloader.php
    │           └── Installer.php
    │       ├── CliTaskCommand.php
    │       ├── InfoCommand.php
    │       ├── BackupCommand.php
    │       ├── PHPDocCommand.php
    │       ├── OCOKCommand.php
    │       └── InstallCommand.php
├── .travis.yml
├── tests
    └── BeyondIT
    │   └── OCOK
    │       └── Tests
    │           ├── Helpers
    │               ├── TestOCOKCommand.php
    │               └── TestController.php
    │           ├── Downloader
    │               └── DownloaderTest.php
    │           ├── Installer
    │               └── InstallerTest.php
    │           ├── BackupCommand
    │               └── BackupCommandTest.php
    │           ├── CliTaskCommand
    │               └── CliTaskCommandTest.php
    │           └── OCOKCommand
    │               └── BasicInitializationTest.php
├── phpunit.xml.dist
├── README.md
├── ocok
├── RoboFile.php
├── composer.json
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | composer.phar
2 | vendor/
3 | nbproject/
4 | .idea/
5 | composer.lock
6 | target/
7 | ocok.phar
8 | *~
9 | 


--------------------------------------------------------------------------------
/src/BeyondIT/OCOK/Helpers/DummyConfig.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK\Helpers;
 4 | 
 5 | class DummyConfig {
 6 |     public function get($name) {
 7 |         return false;
 8 |     }
 9 | }
10 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: php
2 | php:
3 |   - "5.4"
4 | install:
5 |   composer install
6 | before_script:
7 |   - echo "USE mysql;\nUPDATE user SET password=PASSWORD('root') WHERE user='root';\nFLUSH PRIVILEGES;\n" | mysql -u root
8 | script:
9 |   vendor/bin/phpunit


--------------------------------------------------------------------------------
/tests/BeyondIT/OCOK/Tests/Helpers/TestOCOKCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK\Tests\Helpers;
 4 | 
 5 | use BeyondIT\OCOK\OCOKCommand;
 6 | 
 7 | class TestOCOKCommand extends OCOKCommand {
 8 | 
 9 |     public $supported_versions = array();
10 | 
11 |     public function supportedVersions() {
12 |         return $this->supported_versions;
13 |     }
14 | }


--------------------------------------------------------------------------------
/tests/BeyondIT/OCOK/Tests/Helpers/TestController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | class ControllerTestTest extends \Controller {
 5 | 
 6 |     public function index() {
 7 | 
 8 |         if ($this->is_cli === true) {
 9 |             $this->registry->set("test_output","Called by CLI");
10 |         } else {
11 |             $this->registry->set("test_output","Cli Variable not available");
12 |         }
13 | 
14 |     }
15 | 
16 | }


--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit
 3 |     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |     xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.4/phpunit.xsd"
 5 |     backupGlobals="false"
 6 |     colors="true">
 7 | 
 8 |     <testsuites>
 9 |         <testsuite name="OCOK Test Suite">
10 |             <directory>tests</directory>
11 |         </testsuite>
12 |     </testsuites>
13 | 
14 |     <logging>
15 |         <log type="coverage-text" target="php://stdout" showUncoveredFiles="false"/>
16 |     </logging>
17 | 
18 | </phpunit>


--------------------------------------------------------------------------------
/tests/BeyondIT/OCOK/Tests/Downloader/DownloaderTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK\Tests\Downloader;
 4 | 
 5 | 
 6 | use BeyondIT\OCOK\Helpers\Downloader;
 7 | use BeyondIT\OCOK\Helpers\FileSystem;
 8 | 
 9 | class DownloaderTest extends \PHPUnit_Framework_TestCase {
10 | 
11 |     /**
12 |      * @var \BeyondIT\OCOK\Helpers\Downloader
13 |      */
14 |     protected $downloader;
15 | 
16 |     protected $dir;
17 | 
18 |     public function setUp() {
19 |         $this->dir = $dir = getcwd() . DIRECTORY_SEPARATOR . "oc_download";
20 |         $this->downloader = new Downloader($dir);
21 |     }
22 | 
23 |     public function tearDown() {
24 |         $fsh = new FileSystem();
25 |         $fsh->rmdir($this->dir);
26 |     }
27 | 
28 |     public function testDownloadingAndUnzipingOpencart() {
29 |         $this->downloader->process("2.0.1.1");
30 | 
31 |         $this->assertFileExists($this->dir . DIRECTORY_SEPARATOR . "index.php");
32 |         $this->assertFileExists($this->dir . DIRECTORY_SEPARATOR . "admin" . DIRECTORY_SEPARATOR . "index.php");
33 |         $this->assertFileNotExists(dirname(getcwd()) . DIRECTORY_SEPARATOR . "oc.zip");
34 |     }
35 | 
36 | }
37 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | 
 2 | [![Build Status](https://travis-ci.org/Beyond-IT/ocok.svg?branch=master)](https://travis-ci.org/Beyond-IT/ocok)
 3 | [![Codacy Badge](https://www.codacy.com/project/badge/398b5a2d44f3426a81f494e9cb7e2e00)](https://www.codacy.com/public/stefanhuber/ocok)
 4 | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Beyond-IT/ocok/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Beyond-IT/ocok/?branch=master)
 5 | [![Code Climate](https://codeclimate.com/github/Beyond-IT/ocok/badges/gpa.svg)](https://codeclimate.com/github/Beyond-IT/ocok)
 6 | 
 7 | # OCOK: OpenCart OK commandline utility
 8 | 
 9 | * [Installation](http://beyondit.github.io/ocok/#installation)
10 |   * [Composer (global)](http://beyondit.github.io/ocok/#composer-global)
11 |   * [Composer (local)](http://beyondit.github.io/ocok/#composer-local)
12 |   * [Phar Package](http://beyondit.github.io/ocok/#phar)
13 | * [Commands (Usage)](http://beyondit.github.io/ocok/#usage)
14 |   * [Backup Command](http://beyondit.github.io/ocok/#command-backup)
15 |   * [Cli Task Command](http://beyondit.github.io/ocok/#command-clitask)
16 |   * [Install Command](http://beyondit.github.io/ocok/#command-install)
17 | 
18 | 


--------------------------------------------------------------------------------
/ocok:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env php
 2 | <?php
 3 | 
 4 | if(strpos(basename(__FILE__), 'phar')){
 5 |     require_once 'phar://ocok.phar/vendor/autoload.php';
 6 | }
 7 | else{
 8 |     if (file_exists(__DIR__.'/vendor/autoload.php')) {
 9 |         require_once __DIR__.'/vendor/autoload.php';
10 |     } elseif (file_exists(__DIR__.'/../../autoload.php')) {
11 |         require_once __DIR__ . '/../../autoload.php';
12 |     } else {
13 |         require_once 'phar://ocok.phar/vendor/autoload.php';
14 |     }
15 | }
16 | 
17 | use BeyondIT\OCOK\PHPDocCommand;
18 | use BeyondIT\OCOK\CliTaskCommand;
19 | use BeyondIT\OCOK\InfoCommand;
20 | use BeyondIT\OCOK\InstallCommand;
21 | use BeyondIT\OCOK\BackupCommand;
22 | use BeyondIT\OCOK\Helpers\DummyConfig;
23 | use Symfony\Component\Console\Application;
24 | 
25 | $config = new DummyConfig();
26 | 
27 | $application = new Application();
28 | 
29 | $application->setName("OpenCart OK Command Line Utilities");
30 | 
31 | $application->add(new PHPDocCommand);
32 | $application->add(new CliTaskCommand);
33 | $application->add(new InstallCommand);
34 | $application->add(new BackupCommand);
35 | $application->add(new InfoCommand);
36 | 
37 | $application->setDefaultCommand('info');
38 | $application->run();


--------------------------------------------------------------------------------
/RoboFile.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * This is project's console commands configuration for Robo task runner.
 4 |  *
 5 |  * @see http://robo.li/
 6 |  */
 7 | use Symfony\Component\Finder\Finder;
 8 | 
 9 | class RoboFile extends \Robo\Tasks {
10 | 
11 |     function pharPackage() {
12 |         $packer = $this->taskPackPhar('ocok.phar');
13 |         $files = Finder::create()->ignoreVCS(true)
14 |             ->files()
15 |             ->name('*.php')
16 |             ->path('vendor/autoload.php')
17 |             ->path('src')
18 |             ->path('vendor/ifsnop')
19 |             ->path('vendor/symfony')
20 |             ->path('vendor/composer')
21 |             ->in(__DIR__);
22 | 
23 |         foreach ($files as $file) {
24 |             $packer->addFile($file->getRelativePathname(), $file->getRealPath());
25 |         }
26 | 
27 |         $packer
28 |             ->addFile('ocok','ocok')
29 |             ->executable('ocok')
30 |             ->run();
31 |     }
32 | 
33 |     function pharPublish() {
34 |         $this->pharPackage();
35 | 
36 |         rename('ocok.phar', 'ocok-release.phar');
37 |         $this->taskGitStack()->checkout('gh-pages')->run();
38 |         rename('ocok-release.phar', 'ocok.phar');
39 |         $this->taskGitStack()
40 |             ->add('ocok.phar')
41 |             ->commit('ocok.phar published')
42 |             ->push('origin','gh-pages')
43 |             ->checkout('master')
44 |             ->run();
45 |     }
46 | 
47 | }


--------------------------------------------------------------------------------
/src/BeyondIT/OCOK/Helpers/FileSystem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK\Helpers;
 4 | 
 5 | 
 6 | class FileSystem {
 7 | 
 8 |     public function rmdir($dir) {
 9 |         $files = $this->getFilesRecursively($dir);
10 | 
11 |         foreach ($files as $fileinfo) {
12 |             $todo = ($fileinfo->isDir() ? 'rmdir' : 'unlink');
13 |             $todo($fileinfo->getRealPath());
14 |         }
15 | 
16 |         rmdir($dir);
17 |     }
18 | 
19 |     public function getFilesRecursively($dir) {
20 |         return new \RecursiveIteratorIterator(
21 |             new \RecursiveDirectoryIterator($dir, \RecursiveDirectoryIterator::SKIP_DOTS), \RecursiveIteratorIterator::CHILD_FIRST
22 |         );
23 |     }
24 | 
25 |     public function isImage($file) {
26 |         $allowedTypes = array(IMAGETYPE_PNG, IMAGETYPE_JPEG, IMAGETYPE_GIF);
27 |         $detectedType = @exif_imagetype($file);
28 |         return in_array($detectedType, $allowedTypes);
29 |     }
30 | 
31 |     /*
32 |      * http://stackoverflow.com/questions/7497733/how-can-use-php-to-check-if-a-directory-is-empty
33 |      */
34 |     public function isEmptyDirectory($dir) {
35 |         if (!is_readable($dir)) return null;
36 |         $handle = opendir($dir);
37 |         while (false !== ($entry = readdir($handle))) {
38 |             if ($entry != "." && $entry != "..") {
39 |                 return false;
40 |             }
41 |         }
42 |         return true;
43 |     }
44 | 
45 | }


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "beyondit/ocok",
 3 |     "description": "Commandline Utility for OpenCart",
 4 |     "require": {
 5 |         "symfony/console": "~2.5",
 6 |         "ifsnop/mysqldump-php": "~1.4",
 7 |         "codegyre/robo": "0.5.*"
 8 |     },
 9 |     "autoload": {
10 |       "psr-4": {
11 |         "BeyondIT\\" : "src/BeyondIT/"
12 |       }
13 |     },
14 |     "autoload-dev": {
15 |         "psr-4": { "BeyondIT\\OCOK\\Tests\\": "tests/BeyondIT/OCOK/Tests/" }
16 |     },
17 |     "version": "0.2.1",
18 |     "license": "GPL-3.0+",
19 |     "authors": [
20 |         {
21 |             "name": "Stefan Huber",
22 |             "email": "stefan.huber@beyondit.at"
23 |         }
24 |     ],
25 |     "bin": ["ocok"],
26 |     "repositories": [
27 |         {
28 |             "type": "package",
29 |             "package": {
30 |                 "name": "opencart/opencart",
31 |                 "type": "opencart-core",
32 |                 "version": "2.0.1.1",
33 |                 "dist": {
34 |                     "url": "https://github.com/opencart/opencart/archive/2.0.1.1.zip",
35 |                     "type": "zip"
36 |                 },
37 |                 "source": {
38 |                     "url": "https://github.com/opencart/opencart",
39 |                     "type": "git",
40 |                     "reference": "2.0.1.1"
41 |                 }
42 |             }
43 |         }
44 |     ],
45 |     "require-dev": {
46 |         "etki/opencart-core-installer": "~0.1",
47 |         "opencart/opencart": "2.0.1.1",
48 |         "phpunit/phpunit": "4.4.*"
49 |     },
50 |     "extra": {
51 |         "opencart-install-dir": "vendor/opencart"
52 |     }
53 | }
54 | 


--------------------------------------------------------------------------------
/tests/BeyondIT/OCOK/Tests/Installer/InstallerTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK\Tests\Installer;
 4 | 
 5 | 
 6 | use BeyondIT\OCOK\Helpers\Installer;
 7 | 
 8 | class InstallerTest extends \PHPUnit_Framework_TestCase {
 9 | 
10 |     /**
11 |      * @var \BeyondIT\OCOK\Helpers\Installer
12 |      */
13 |     protected $installer;
14 | 
15 |     protected $options;
16 | 
17 |     protected $oc_dir;
18 | 
19 |     public function setUp() {
20 |         $this->oc_dir = getcwd() . "/vendor/opencart";
21 | 
22 |         $this->installer = new Installer($this->oc_dir);
23 | 
24 |         $this->options = array(
25 |             'db_hostname' => 'localhost' ,
26 |             'db_username' => 'root' ,
27 |             'db_password' => 'root' ,
28 |             'db_database' => 'ocok_opencart_test' ,
29 |             'db_prefix'   => 'oc_',
30 |             'db_driver'   => 'mysqli',
31 |             'email'       => 'test@ocok.com' ,
32 |             'username'    => 'admin' ,
33 |             'password'    => 'password' ,
34 |             'http_server' => 'http://localhost/opencart/'
35 |         );
36 | 
37 |         $this->installer->removeDatabase($this->options);
38 |     }
39 | 
40 |     public function testInstallingOpenCart() {
41 |         $options = $this->options;
42 |         $output = $this->installer->install($options);
43 | 
44 |         $this->assertEquals("SUCCESS! Opencart successfully installed on your server",$output[0]);
45 |         $this->assertEquals("Store link: " . $options['http_server'],$output[1]);
46 |         $this->assertEquals("Admin link: " . $options['http_server'] . "admin/",$output[2]);
47 | 
48 |         $this->assertTrue(file_exists($this->oc_dir . DIRECTORY_SEPARATOR . "config.php"));
49 |         $this->assertTrue(file_exists($this->oc_dir . DIRECTORY_SEPARATOR . "admin" . DIRECTORY_SEPARATOR . "config.php"));
50 | 
51 |         $this->installer->removeConfigFiles($options);
52 |         $this->assertFalse(file_exists($this->oc_dir . DIRECTORY_SEPARATOR . "config.php"));
53 |         $this->assertFalse(file_exists($this->oc_dir . DIRECTORY_SEPARATOR . "admin" . DIRECTORY_SEPARATOR . "config.php"));
54 | 
55 |         $this->installer->removeDatabase($options);
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/BeyondIT/OCOK/Helpers/Downloader.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK\Helpers;
 4 | 
 5 | use BeyondIT\OCOK\Helpers\FileSystem;
 6 | 
 7 | class Downloader {
 8 | 
 9 |     protected $dir;
10 |     protected $tmp;
11 | 
12 |     protected $file_system_helper;
13 | 
14 |     protected $version_mapping = array(
15 |         '2.0.1.1' => 'https://github.com/opencart/opencart/archive/2.0.1.1.zip'
16 |     );
17 | 
18 |     function __construct($dir) {
19 |         $this->file_system_helper = new FileSystem();
20 |         $this->dir = $dir;
21 |         $this->tmp = dirname(getcwd()) . DIRECTORY_SEPARATOR . ".tmp";
22 |         $this->oc_zip = dirname(getcwd()) .DIRECTORY_SEPARATOR . "oc.zip";
23 | 
24 |         if (!is_dir($dir)) {
25 |             mkdir($dir);
26 |         }
27 |         if (is_dir($this->tmp)) {
28 |             $this->file_system_helper->rmdir($this->tmp);
29 |         }
30 |         mkdir($this->tmp);
31 |     }
32 | 
33 |     public function process($version) {
34 |         $check = $this->download($version);
35 | 
36 |         if ($check) {
37 |             $check = $this->unzip();
38 |         }
39 | 
40 |         if ($check) {
41 |             if (is_dir($this->tmp)) {
42 |                 $this->file_system_helper->rmdir($this->tmp);
43 |             }
44 |             if (is_file($this->oc_zip)) {
45 |                 unlink($this->oc_zip);
46 |             }
47 |         }
48 |     }
49 | 
50 |     public function download($version) {
51 |         if (!$this->version_mapping[$version]) {
52 |             return false;
53 |         }
54 | 
55 |         return file_put_contents($this->oc_zip, fopen($this->version_mapping[$version], 'r'));
56 |     }
57 | 
58 |     public function unzip() {
59 |         if (is_file($this->oc_zip)) {
60 |             $za = new \ZipArchive();
61 |             $za->open($this->oc_zip);
62 | 
63 |             $base = "";
64 |             for ($i = 0; $i < $za->numFiles; $i++) {
65 |                 $stat = $za->statIndex($i);
66 |                 if (preg_match("/.*\/upload\//i", $stat['name'])) {
67 |                     $base = $stat["name"];
68 |                     break;
69 |                 }
70 |             }
71 | 
72 |             $za->extractTo($this->tmp);
73 |             return rename($this->tmp.DIRECTORY_SEPARATOR.$base,$this->dir);
74 |         }
75 | 
76 |         return false;
77 |     }
78 | 
79 | }


--------------------------------------------------------------------------------
/src/BeyondIT/OCOK/CliTaskCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK;
 4 | 
 5 | use Symfony\Component\Console\Input\InputInterface;
 6 | use Symfony\Component\Console\Output\OutputInterface;
 7 | use Symfony\Component\Console\Input\InputArgument;
 8 | use Symfony\Component\Console\Input\InputOption;
 9 | 
10 | class CliTaskCommand extends OCOKCommand {
11 |     
12 |     public function supportedVersions() {
13 |         return array('2','1.5');
14 |     }
15 |     
16 |     protected function configure() {
17 |         $this->setName("run")
18 |              ->setDescription("Run OpenCart controllers as tasks from commandline")
19 |              ->addOption("catalog","c", InputOption::VALUE_NONE	, "Set the catalog controllers as execution scope, default scope is admin")
20 |              ->addOption("post","p", InputOption::VALUE_NONE	, "Changes the custom arguments as POST parameters, default is GET")
21 |              ->addArgument("route", InputArgument::REQUIRED, "Set the route for the Task Controller")
22 |              ->addArgument("args", InputArgument::IS_ARRAY, "Custom arguments, which are set as GET or POST (-p option) parameters for the controller script. Added as key/value pairs (e.g. key=value)");
23 |     }
24 |     
25 |     protected function execute(InputInterface $input, OutputInterface $output) {
26 |         if (parent::execute($input, $output)) {
27 |                             
28 |             if (!$input->getOption("catalog")) {
29 |                 chdir('admin');  
30 |             }
31 |                                     
32 |             foreach ($input->getArgument("args") as $arg) {
33 |                 $pair = explode("=", $arg);
34 |                 if (count($pair) === 2) {
35 |                     if ($input->getOption("post")) {
36 |                         $_POST[$pair[0]] = $pair[1];
37 |                     } else {
38 |                         $_GET[$pair[0]] = $pair[1];
39 |                     }                    
40 |                 }
41 |             }
42 | 
43 |             ob_start();
44 |             require_once $this->getOCDirectory() . DIRECTORY_SEPARATOR . "index.php";
45 |             ob_end_clean();
46 | 
47 |             $registry->set('is_cli',true);
48 |             $this->registry = $registry;
49 | 
50 |             $controller = new \Front($registry);
51 |             $controller->dispatch(new \Action($input->getArgument("route")), new \Action('error/not_found'));
52 | 
53 | 
54 |         }
55 |     }    
56 | }
57 | 


--------------------------------------------------------------------------------
/tests/BeyondIT/OCOK/Tests/BackupCommand/BackupCommandTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: stefan
 5 |  * Date: 28.01.15
 6 |  * Time: 20:40
 7 |  */
 8 | 
 9 | namespace BeyondIT\OCOK\Tests\BackupCommand;
10 | 
11 | 
12 | use BeyondIT\OCOK\BackupCommand;
13 | use BeyondIT\OCOK\Helpers\DummyConfig;
14 | use BeyondIT\OCOK\Helpers\Installer;
15 | use Symfony\Component\Console\Application;
16 | use Symfony\Component\Console\Tester\CommandTester;
17 | 
18 | class BackupCommandTest extends \PHPUnit_Framework_TestCase {
19 | 
20 |     /**
21 |      * @var \Symfony\Component\Console\Application
22 |      */
23 |     protected $application;
24 | 
25 |     /**
26 |      * @var \BeyondIT\OCOK\Helpers\Installer
27 |      */
28 |     protected $installer;
29 | 
30 |     protected $execDir;
31 | 
32 | 
33 |     public function setUp() { // $this->markTestSkipped("Constants already defined problems");
34 |         $this->application = new Application();
35 |         $this->application->add(new BackupCommand());
36 | 
37 |         $this->execDir = getcwd() . "/vendor/opencart";
38 | 
39 |         $this->installer = new Installer($this->execDir);
40 | 
41 |         $this->options = array(
42 |             'db_hostname' => 'localhost' ,
43 |             'db_username' => 'root' ,
44 |             'db_password' => 'root' ,
45 |             'db_database' => 'ocok_opencart_test' ,
46 |             'db_prefix'   => 'oc_',
47 |             'db_driver'   => 'mysqli',
48 |             'email'       => 'test@ocok.com' ,
49 |             'username'    => 'admin' ,
50 |             'password'    => 'password' ,
51 |             'http_server' => 'http://localhost/opencart/'
52 |         );
53 | 
54 |         $this->installer->install($this->options);
55 |     }
56 | 
57 |     public function tearDown() {
58 |         $this->installer->removeDatabase($this->options);
59 |         $this->installer->removeConfigFiles();
60 |     }
61 | 
62 |     /**
63 |      * @runInSeparateProcess
64 |      * @preserveGlobalState disabled
65 |      */
66 |     public function testBackingUpCatalogImagesAndDatabase() {
67 |         chdir($this->execDir);
68 | 
69 |         $command = $this->application->find('backup');
70 | 
71 |         $commandTester = new CommandTester($command);
72 |         $commandTester->execute(array(
73 |             '--images' => null,
74 |             '--database' => null));
75 | 
76 |         foreach (glob("ocok_backup_".date("Y_m_d_")."*.zip") as $file) {
77 |             $this->assertGreaterThan(0,filesize($file));
78 |             unlink($file);
79 |             $this->assertFalse(is_file($file));
80 | 
81 |         }
82 |     }
83 | }


--------------------------------------------------------------------------------
/src/BeyondIT/OCOK/InfoCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK;
 4 | 
 5 | use Symfony\Component\Console\Input\InputInterface;
 6 | use Symfony\Component\Console\Output\OutputInterface;
 7 | use Symfony\Component\Console\Input\InputArgument;
 8 | use Symfony\Component\Console\Input\InputOption;
 9 | 
10 | class InfoCommand extends OCOKCommand {
11 |     
12 |     public function supportedVersions() {
13 |         return array('1','2');
14 |     }
15 |     
16 |     protected function configure() {
17 |         $this->setName('info')
18 |              ->setDescription('OpenCart Commandline Utilities');
19 |     }
20 | 
21 |     public function printOCOKInfo(OutputInterface $output,$commands,$version = null) {
22 | 
23 |         $output->writeln("<info>    ___       ___       ___       ___    </info>");
24 |         $output->writeln("<info>   /\  \     /\  \     /\  \     /\__\   </info>");
25 |         $output->writeln("<info>  /::\  \   /::\  \   /::\  \   /:/ _/_  </info>");
26 |         $output->writeln('<info> /:/\:\__\ /:/\:\__\ /:/\:\__\ /::-"\__\ </info>');
27 |         $output->writeln('<info> \:\/:/  / \:\ \/__/ \:\/:/  / \;:;-",-" </info>');
28 |         $output->writeln("<info>  \::/  /   \:\__\    \::/  /   |:|  |   </info>");
29 |         $output->writeln("<info>   \/__/     \/__/     \/__/     \|__|   </info>");
30 | 
31 |         $output->writeln("_______________________________________");
32 |         $output->writeln("<info>OCOK - OpenCart Commandline Utilities</info>");
33 | 
34 |         if ($version) {
35 |             $output->writeln("OpenCart Version <comment>$version</comment> found");
36 |         } else {
37 |             $output->writeln("<info>No OpenCart installation found</info>");
38 |         }
39 |         $output->writeln("");
40 | 
41 |         $output->writeln("<comment>Available commands:</comment>");
42 |         $spaces = "          ";
43 |         foreach($commands as $command) {
44 |             $output->writeln("  <info>".$command['name']."</info>" . substr($spaces, strlen($command['name'])) . $command['desc']);
45 |         }
46 |         $output->writeln("");
47 |     }
48 | 
49 |     protected function execute(InputInterface $input, OutputInterface $output) {
50 |         $application = $this->getApplication();
51 | 
52 |         if (!$this->checkOC()) {
53 |             $version = null;
54 |             $cmds[] = $application->get("install");
55 |             $cmds[] = $application->get("info");
56 |             $cmds[] = $application->get("help");
57 |         } else {
58 |             $version = $this->getVersion();
59 |             $cmds = $application->all();
60 |         }
61 | 
62 |         $commands = array();
63 |         foreach($cmds as $cmd) {
64 |             $commands[] = array(
65 |                 'name' => $cmd->getName(),
66 |                 'desc' => $cmd->getDescription()
67 |             );
68 |         }
69 | 
70 |         $this->printOCOKInfo($output,$commands,$version);
71 |     }
72 | }
73 | 


--------------------------------------------------------------------------------
/tests/BeyondIT/OCOK/Tests/CliTaskCommand/CliTaskCommandTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK\Tests\CliTaskCommand;
 4 | 
 5 | 
 6 | use BeyondIT\OCOK\Helpers\DummyConfig;
 7 | use BeyondIT\OCOK\Helpers\FileSystem;
 8 | use BeyondIT\OCOK\CliTaskCommand;
 9 | use BeyondIT\OCOK\Helpers\Installer;
10 | use Symfony\Component\Console\Application;
11 | use Symfony\Component\Console\Tester\CommandTester;
12 | 
13 | // needs global $config variable
14 | // for preventing strange problem with php global call
15 | $config = new DummyConfig();
16 | 
17 | class CliTaskCommandTest extends \PHPUnit_Framework_TestCase {
18 | 
19 |     /**
20 |      * @var \BeyondIT\OCOK\Helpers\Installer
21 |      */
22 |     protected $installer;
23 | 
24 |     /**
25 |      * @var \BeyondIT\OCOK\Helpers\FileSystem
26 |      */
27 |     protected $fsh;
28 | 
29 |     protected $test_controller = "/tests/BeyondIT/OCOK/Tests/Helpers/TestController.php";
30 |     protected $oc_controller_dir = "/vendor/opencart/admin/controller/test/";
31 |     protected $controller_file_name = "test.php";
32 |     protected $execDir;
33 | 
34 |     public function setUp() {
35 |         $this->application = new Application();
36 |         $this->application->add(new CliTaskCommand());
37 | 
38 |         $dir = getcwd();
39 |         $this->execDir = getcwd() . "/vendor/opencart";
40 | 
41 |         $this->installer = new Installer($this->execDir);
42 |         $this->options = array(
43 |             'db_hostname' => 'localhost' ,
44 |             'db_username' => 'root' ,
45 |             'db_password' => 'root' ,
46 |             'db_database' => 'ocok_opencart_test' ,
47 |             'db_prefix'   => 'oc_',
48 |             'db_driver'   => 'mysqli',
49 |             'email'       => 'test@ocok.com' ,
50 |             'username'    => 'admin' ,
51 |             'password'    => 'password' ,
52 |             'http_server' => 'http://localhost/opencart/'
53 |         );
54 |         $this->installer->install($this->options);
55 | 
56 |         $this->fsh = new FileSystem();
57 |         $this->oc_controller_dir = $dir . $this->oc_controller_dir;
58 |         $this->test_controller = $dir . $this->test_controller;
59 | 
60 |         if (!is_dir($this->oc_controller_dir)) {
61 |             mkdir($this->oc_controller_dir);
62 |         }
63 | 
64 |         copy($this->test_controller,$this->oc_controller_dir . $this->controller_file_name);
65 |     }
66 | 
67 |     public function tearDown() {
68 |         if (is_dir($this->oc_controller_dir)) {
69 |             $this->fsh->rmdir($this->oc_controller_dir);
70 |         }
71 | 
72 |         $this->installer->removeDatabase($this->options);
73 |         $this->installer->removeConfigFiles();
74 |     }
75 | 
76 |     public function testTestCommandExecution() {
77 |         chdir($this->execDir);
78 |         $command = $this->application->find('run');
79 | 
80 |         $commandTester = new CommandTester($command);
81 | 
82 |         if (defined("HTTP_SERVER")) {
83 |             echo "is defined already";
84 |         }
85 |         $commandTester->execute(array('route' => 'test/test'));
86 | 
87 |         $this->assertRegExp("/^.*Called by CLI*$/",$command->registry->get('test_output'));
88 |     }
89 | 
90 | }
91 | 


--------------------------------------------------------------------------------
/tests/BeyondIT/OCOK/Tests/OCOKCommand/BasicInitializationTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace BeyondIT\OCOK\Tests\OCOKCommand;
  4 | 
  5 | use BeyondIT\OCOK\PHPDocCommand;
  6 | use BeyondIT\OCOK\CliTaskCommand;
  7 | use BeyondIT\OCOK\InfoCommand;
  8 | use BeyondIT\OCOK\BackupCommand;
  9 | use BeyondIT\OCOK\OCOKCommand;
 10 | use BeyondIT\OCOK\Helpers\DummyConfig;
 11 | use BeyondIT\OCOK\Tests\Helpers\TestOCOKCommand;
 12 | use Symfony\Component\Console\Application;
 13 | use Symfony\Component\Console\Tester\CommandTester;
 14 | 
 15 | class BasicInitializationTest extends \PHPUnit_Framework_TestCase {
 16 | 
 17 |     /**
 18 |      * @var \Symfony\Component\Console\Application
 19 |      */
 20 |     protected $application;
 21 | 
 22 |     protected $execDir;
 23 | 
 24 |     public function setUp() {
 25 |         $config = new DummyConfig();
 26 |         $this->application = new Application();
 27 |         $this->application->add(new CliTaskCommand);
 28 | 
 29 |         $this->execDir = getcwd() . "/vendor/opencart";
 30 |     }
 31 | 
 32 |     public function testCommandInsideWrongDirectory() {
 33 |         $command = $this->application->find('run');
 34 |         $commandTester = new CommandTester($command);
 35 |         $commandTester->execute(
 36 |             array('command' => $command->getName() ,
 37 |                   'route' => 'catalog/attribute')
 38 |         );
 39 | 
 40 |         $this->assertRegExp("/^.*ERROR: No Opencart installation found!.*$/",$commandTester->getDisplay());
 41 |     }
 42 | 
 43 |     public function testCheckWithUninstalledOpenCart() {
 44 |         chdir($this->execDir);
 45 | 
 46 |         $command = new TestOCOKCommand("testCMD");
 47 |         $this->assertFalse($command->checkOC());
 48 |     }
 49 | 
 50 |     public function testCheckWithFakedInstalledOpenCart() {
 51 |         chdir($this->execDir);
 52 | 
 53 |         touch("config.php");
 54 |         touch("admin/config.php");
 55 | 
 56 |         $command = new TestOCOKCommand("testCMD");
 57 |         $this->assertTrue($command->checkOC());
 58 | 
 59 |         unlink("config.php");
 60 |         unlink("admin/config.php");
 61 |     }
 62 | 
 63 |     public function testCheckVersionOfOpenCart() {
 64 |         chdir($this->execDir);
 65 | 
 66 |         $command = new TestOCOKCommand("testCMD");
 67 |         $version = $command->loadVersion($this->execDir);
 68 | 
 69 |         $this->assertEquals("2.0.1.1",$version);
 70 |     }
 71 | 
 72 |     public function testCheckVersionSupportCases() {
 73 |         $command = new TestOCOKCommand("testCMD");
 74 | 
 75 | 
 76 |         $command->supported_versions = array("2.0.1.0");
 77 | 
 78 |         $command->setVersion("2.0.1.1");
 79 |         $this->assertFalse($command->isVersionSupported());
 80 | 
 81 |         $command->setVersion("2.0.1.0");
 82 |         $this->assertTrue($command->isVersionSupported());
 83 | 
 84 | 
 85 |         $command->supported_versions = array("1.5","2.0");
 86 | 
 87 |         $command->setVersion("2.0.1.1");
 88 |         $this->assertTrue($command->isVersionSupported());
 89 | 
 90 |         $command->setVersion("1.5.6.4");
 91 |         $this->assertTrue($command->isVersionSupported());
 92 | 
 93 |         $command->setVersion("2.1.0.0");
 94 |         $this->assertFalse($command->isVersionSupported());
 95 | 
 96 |         $command->setVersion("1.4");
 97 |         $this->assertFalse($command->isVersionSupported());
 98 |     }
 99 | 
100 | }
101 | 


--------------------------------------------------------------------------------
/src/BeyondIT/OCOK/BackupCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK;
 4 | 
 5 | use BeyondIT\OCOK\Helpers\FileSystem;
 6 | use Symfony\Component\Console\Input\InputInterface;
 7 | use Symfony\Component\Console\Output\OutputInterface;
 8 | use Symfony\Component\Console\Input\InputArgument;
 9 | use Symfony\Component\Console\Input\InputOption;
10 | use Ifsnop\Mysqldump\Mysqldump;
11 | 
12 | class BackupCommand extends OCOKCommand {
13 | 
14 |     protected $backup_folder = '';
15 |     protected $backup_db = 'db_backup.sql';
16 | 
17 |     public function supportedVersions() {
18 |         return array('1.5', '2');
19 |     }
20 | 
21 |     protected function configure() {
22 |         $this->setName('backup')
23 |                 ->setDescription('Backup OpenCart Installation')
24 |                 ->addOption("images", "i", InputOption::VALUE_NONE, "Add images to backup")
25 |                 ->addOption("database", "d", InputOption::VALUE_NONE, "Add database to backup");
26 |     }
27 | 
28 |     protected function execute(InputInterface $input, OutputInterface $output) {
29 |         if (parent::execute($input, $output)) {
30 |             $file_system_helper = new FileSystem();
31 | 
32 |             $this->loadOCConfig();
33 |             $this->backup_folder = $this->getOCDirectory() . DIRECTORY_SEPARATOR . ".backup_tmp/";
34 | 
35 |             $za = new \ZipArchive();
36 |             if ($za->open("ocok_backup_" . date("Y_m_d_H_i") . ".zip", \ZipArchive::OVERWRITE)) {
37 | 
38 |                 if (is_dir($this->backup_folder)) {
39 |                     $file_system_helper->rmdir($this->backup_folder);
40 |                 }
41 | 
42 |                 mkdir($this->backup_folder);
43 | 
44 |                 $image_path = DIR_IMAGE;
45 |                 if ($this->isVersion('2')) {
46 |                     $image_path .= 'catalog/';
47 |                 } elseif ($this->isVersion('1')) {
48 |                     $image_path .= 'data/';
49 |                 }
50 | 
51 |                 if ($input->getOption("images")) {
52 |                     $files = $file_system_helper->getFilesRecursively($image_path);
53 |                     foreach ($files as $file) {
54 |                         if ($file->isFile() && $file->isReadable() && $file_system_helper->isImage($file->getPathname())) {
55 | 
56 |                             // remove basefolder prefix from path
57 |                             if (substr($file->getPathname(), 0, strlen($this->getOCDirectory())) == $this->getOCDirectory()) {
58 |                                 $path = substr($file->getPathname(), strlen($this->getOCDirectory()));
59 |                             }
60 | 
61 |                             $za->addFile($file->getPathname(), substr($path, 1));
62 |                         }
63 |                     }
64 |                 }
65 | 
66 |                 if ($input->getOption("database")) {
67 |                     $dumper = new Mysqldump(
68 |                             DB_DATABASE, DB_USERNAME, DB_PASSWORD, DB_HOSTNAME, 'mysql', array(
69 |                         'add-drop-table' => true,
70 |                         'add-drop-database' => true,
71 |                         'databases' => true
72 |                             )
73 |                     );
74 | 
75 |                     $dumper->start($this->backup_folder . $this->backup_db);
76 |                     $za->addFile($this->backup_folder . $this->backup_db, $this->backup_db);
77 |                 }
78 |                 
79 |                 $za->close();
80 |                 $file_system_helper->rmdir($this->backup_folder);
81 |             }
82 |         }
83 |     }
84 | 
85 | }
86 | 


--------------------------------------------------------------------------------
/src/BeyondIT/OCOK/Helpers/Installer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BeyondIT\OCOK\Helpers;
 4 | 
 5 | 
 6 | class Installer {
 7 | 
 8 |     protected $registry;
 9 |     protected $loader;
10 | 
11 |     protected $dir_opencart;
12 | 
13 |     function __construct($dir_opencart) {
14 |         $this->dir_opencart = $dir_opencart;
15 |     }
16 | 
17 |     /**
18 |      * @params options array options array for cli installer
19 |      * @return array output of cli exec
20 |      *
21 |      */
22 |     public function install($options) {
23 |         chdir($this->dir_opencart . DIRECTORY_SEPARATOR . "install");
24 | 
25 |         $this->removeDatabase($options);
26 |         $this->createDatabase($options);
27 | 
28 |         $exec =  "php cli_install.php install";
29 |         $exec .= " --http_server " . $options['http_server'];
30 |         $exec .= " --db_hostname " . $options['db_hostname'];
31 |         $exec .= " --db_username " . $options['db_username'];
32 |         $exec .= " --db_password " . $options['db_password'];
33 |         $exec .= " --db_database " . $options['db_database'];
34 |         $exec .= " --db_prefix "   . $options['db_prefix'];
35 |         $exec .= " --db_driver "   . $options['db_driver'];
36 |         $exec .= " --email "       . $options['email'];
37 |         $exec .= " --username "    . $options['username'];
38 |         $exec .= " --password "    . $options['password'];
39 | 
40 |         exec($exec,$output);
41 |         return $output;
42 |     }
43 | 
44 |     public function removeInstallationFiles() {
45 |         chdir($this->dir_opencart);
46 | 
47 |         if (is_file($this->dir_opencart . DIRECTORY_SEPARATOR . "config-dist.php")) {
48 |             unlink($this->dir_opencart . DIRECTORY_SEPARATOR . "config-dist.php");
49 |         }
50 | 
51 |         if (is_file($this->dir_opencart . DIRECTORY_SEPARATOR . "admin" . DIRECTORY_SEPARATOR . "config-dist.php")) {
52 |             unlink($this->dir_opencart . DIRECTORY_SEPARATOR . "admin" . DIRECTORY_SEPARATOR . "config-dist.php");
53 |         }
54 | 
55 |         // remove install folder
56 |         if (is_dir($this->dir_opencart . DIRECTORY_SEPARATOR . "install")) {
57 |             $fsh = new FileSystem();
58 |             $fsh->rmdir($this->dir_opencart . DIRECTORY_SEPARATOR . "install");
59 |         }
60 |     }
61 | 
62 |     public function createDatabase($options) {
63 |         $mysqli = new \mysqli($options['db_hostname'],$options['db_username'],$options['db_password']);
64 |         $mysqli->query("create database if not exists " . $options['db_database']);
65 |         $mysqli->close();
66 |     }
67 | 
68 |     public function removeDatabase($options) {
69 |         $mysqli = new \mysqli($options['db_hostname'],$options['db_username'],$options['db_password']);
70 |         if ($mysqli->select_db($options['db_database'])) {
71 |             $mysqli->query("drop database " . $options['db_database']);
72 |         }
73 |         $mysqli->close();
74 |     }
75 | 
76 |     public function removeConfigFiles() {
77 |         if ($this->dir_opencart) {
78 |             $directory = $this->dir_opencart;
79 |         } else {
80 |             $directory = getcwd();
81 |         }
82 | 
83 |         $catalog_config = $directory . DIRECTORY_SEPARATOR . "config.php";
84 |         $admin_config   = $directory . DIRECTORY_SEPARATOR . "admin" . DIRECTORY_SEPARATOR . "config.php";
85 | 
86 |         if (file_exists($catalog_config) && is_file($catalog_config)) {
87 |             @unlink($catalog_config);
88 |         }
89 |         if (file_exists($admin_config) && is_file($admin_config)) {
90 |             @unlink($admin_config);
91 |         }
92 |     }
93 | }


--------------------------------------------------------------------------------
/src/BeyondIT/OCOK/PHPDocCommand.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace BeyondIT\OCOK;
  4 | 
  5 | use Symfony\Component\Console\Input\InputInterface;
  6 | use Symfony\Component\Console\Output\OutputInterface;
  7 | 
  8 | class PHPDocCommand extends OCOKCommand {
  9 |     
 10 |     protected function configure() {
 11 |         $this->setName("phpdoc")
 12 |              ->setDescription("Add PhpDoc for better supporting autocomplete features in IDEs");
 13 |     }
 14 |         
 15 |     public function getModels( $basedir ) {
 16 |         $permission = array();
 17 |         $files = glob( $basedir . 'model/*/*.php' );
 18 |         foreach ( $files as $file ) {
 19 |             $data = explode( '/', dirname( $file ) );
 20 |             $names = explode( '_', basename( $file, '.php' ) );
 21 |             
 22 |             if ( !$names ) {
 23 |                 $names = array( basename( $file, '.php' ) );
 24 |             }
 25 |             
 26 |             $permission[] = 'Model' . ucfirst( end( $data ) ) . implode( '', array_map( function ( $x ) {
 27 |                 return ucfirst( $x );
 28 |             }, $names ) ) . ' $model_' . end( $data ) . '_' . basename( $file, '.php' );
 29 |         }
 30 |         return $permission;
 31 |     }
 32 |     
 33 |     public function getLineOfFile( $fp, $needle ) {
 34 |         rewind( $fp );
 35 |         $lineNumber = 0;
 36 |         
 37 |         while ( !feof( $fp ) ) {
 38 |             $line = fgets( $fp );
 39 |             if ( !( strpos( $line, $needle ) === false ) ) {
 40 |                 break;
 41 |             }
 42 |             $lineNumber++;
 43 |         }
 44 |         
 45 |         return feof( $fp ) ? null : $lineNumber;
 46 |     }
 47 |     
 48 |     public function exec_v15(InputInterface $input, OutputInterface $output) {
 49 |         
 50 |     }
 51 |     
 52 |     public function exec_v2(InputInterface $input, OutputInterface $output) {
 53 |         
 54 |     }
 55 |     
 56 |     protected function execute(InputInterface $input, OutputInterface $output) {
 57 |         if (parent::execute($input, $output)) {          
 58 |             
 59 |             $this->loadOCConfig();
 60 |             
 61 |             $properties = array(
 62 |                 'string $id',
 63 |                 'string $template',
 64 |                 'array $children',
 65 |                 'array $data',
 66 |                 'string $output'                
 67 |             );
 68 |             
 69 |             // TODO: get all library classes as well, maybe extract from registry somehow...
 70 |             
 71 |             $searchLine = "abstract class Controller {";
 72 |             $pathToController = "engine/controller.php";
 73 |             $catalogModels = $this->getModels(\DIR_APPLICATION);
 74 |             $adminModels = $this->getModels( str_ireplace( "catalog/", "admin/", \DIR_APPLICATION ) );
 75 |             $textToInsert = array_unique( array_merge( $properties, $catalogModels, $adminModels ) );
 76 |             
 77 |             //get line number where start Controller description
 78 |             $fp = fopen( \DIR_SYSTEM . $pathToController, 'r' );
 79 |             $lineNumber = $this->getLineOfFile( $fp, $searchLine );
 80 |             fclose( $fp );
 81 |             
 82 |             //regenerate Controller text with properties
 83 |             $file = new \SplFileObject( \DIR_SYSTEM . $pathToController );
 84 |             $file->seek( $lineNumber );
 85 |             $tempFile = sprintf( "<?php %s \t/**%s", PHP_EOL, PHP_EOL );
 86 |             foreach ( $textToInsert as $val ) {
 87 |                 $tempFile .= sprintf( "\t* @property %s%s", $val, PHP_EOL );
 88 |             }
 89 |             $tempFile .= sprintf( "\t**/%s%s%s", PHP_EOL, $searchLine, PHP_EOL );
 90 |             while ( !$file->eof() ) {
 91 |                 $tempFile .= $file->fgets();
 92 |             }
 93 |             
 94 |             //write Controller
 95 |             $fp = fopen( \DIR_SYSTEM . $pathToController, 'w' );
 96 |             fwrite( $fp, $tempFile );
 97 |             fclose( $fp );
 98 |             
 99 |         }
100 |     }
101 | 
102 |     public function supportedVersions() {
103 |         return array('1.5');
104 |     }
105 | 
106 | }
107 | 


--------------------------------------------------------------------------------
/src/BeyondIT/OCOK/OCOKCommand.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace BeyondIT\OCOK;
  4 | 
  5 | use Symfony\Component\Console\Command\Command;
  6 | use Symfony\Component\Console\Input\InputInterface;
  7 | use Symfony\Component\Console\Output\OutputInterface;
  8 | 
  9 | abstract class OCOKCommand extends Command {
 10 |     protected $version = '';
 11 |     /*
 12 |      * Method should return a String array of supported Version numbers
 13 |      * e.g. ['1.5','2'] 
 14 |      * 
 15 |      * return array
 16 |      */
 17 |     abstract public function supportedVersions();
 18 | 
 19 |     /**
 20 |      *  Installed OpenCart File Structure check
 21 |      */
 22 |     protected $files = array(
 23 |         'catalog/index' => 'index.php' ,
 24 |         'admin/index'   => 'admin/index.php',
 25 |         'catalog/config'=> 'config.php' ,
 26 |         'admin/config'  => 'admin/config.php'
 27 |     );
 28 | 
 29 |     /**
 30 |      *  Uninstalled OpenCart File Structure check
 31 |      */
 32 |     protected $uninstalled_files = array(
 33 |         'catalog/index' => 'index.php' ,
 34 |         'admin/index'   => 'admin/index.php',
 35 |         'install/cli'   => 'install/cli_install.php',
 36 |         'install/index' => 'install/index.php',
 37 |         'install/sql'   => 'install/opencart.sql'
 38 |     );
 39 |     
 40 |     // GETTERS
 41 |     
 42 |     public function getOCDirectory() {
 43 |         return getcwd();
 44 |     }
 45 |     
 46 |     public function getVersion() {
 47 |         return $this->version;
 48 |     }
 49 | 
 50 |     public function setVersion($version) {
 51 |         $this->version = $version;
 52 |     }
 53 |     
 54 |     // VERSION SECTION
 55 |     
 56 |     public function isVersion($version) {
 57 |         return strpos($this->getVersion(), $version) === 0 ? true : false;
 58 |     }
 59 |     
 60 |     public function isVersionSupported() {
 61 |         $supported = false;
 62 |         foreach ($this->supportedVersions() as $supportedVersion) {
 63 |             if ($this->isVersion($supportedVersion)) {
 64 |                 $supported = true;
 65 |             }
 66 |         }
 67 |         return $supported;
 68 |     }
 69 | 
 70 |     public function loadOCConfig() {
 71 |         require_once 'config.php';
 72 |     }
 73 | 
 74 |     public function loadVersion($execDir) {
 75 |         $output = false;
 76 |         
 77 |         $handle = fopen($execDir .DIRECTORY_SEPARATOR. $this->files['catalog/index'], "r");
 78 |         if ($handle) {
 79 |             while (($line = fgets($handle)) !== false) {
 80 |                 $pos = strpos($line, "VERSION");
 81 |                 if ($pos > 0) {
 82 |                     // eval(substr_replace($line,"_HACK",$pos+7,0));
 83 |                     preg_match("/[0-9]?\.[0-9]{1,2}\.[0-9]{1,2}\.\w{1,3}/i", $line,$match);
 84 |                     $output = $match[0];
 85 |                     break;
 86 |                 }
 87 |             }
 88 |         }
 89 | 
 90 |         return $output;
 91 |     }
 92 | 
 93 |     public function checkUninstalledOC() {
 94 |         $execDir = $this->getOCDirectory();
 95 |         $output = true;
 96 | 
 97 |         // check if installed OC is present
 98 |         foreach ($this->uninstalled_files as $file) {
 99 |             if (!is_file($execDir . DIRECTORY_SEPARATOR . $file)) {
100 |                 $output = false;
101 |             }
102 |         }
103 | 
104 |         // check the OC Version
105 |         if ($output && $version = $this->loadVersion($execDir)) {
106 |             $this->setVersion($version);
107 |         }
108 | 
109 |         return $output;
110 |     }
111 | 
112 |     public function checkOC() {
113 |         $execDir = $this->getOCDirectory();
114 |         $output = true;
115 |                 
116 |         // check if installed OC is present
117 |         foreach ($this->files as $file) {
118 |             if (!is_file($execDir . DIRECTORY_SEPARATOR . $file)) {
119 |                 $output = false;
120 |             }
121 |         }
122 |                 
123 |         // check the OC Version
124 |         if ($output && $version = $this->loadVersion($execDir)) {
125 |             $this->setVersion($version);
126 |         }
127 |                 
128 |         return $output;
129 |     }
130 |     
131 |     protected function execute(InputInterface $input, OutputInterface $output) {
132 |         $result = true;
133 |                 
134 |         if (!$this->checkOC()) {
135 |             $result = false;
136 |             $output->writeln("<error>ERROR: No Opencart installation found!</error>");
137 |         } else if (!$this->isVersionSupported()) {
138 |             $result = false;
139 |             $output->writeln("<error>ERROR: OpenCart Version ".$this->getVersion()." is not supported!</error>");
140 |         }
141 |         
142 |         return $result;
143 |     }
144 |     
145 | }
146 | 


--------------------------------------------------------------------------------
/src/BeyondIT/OCOK/InstallCommand.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace BeyondIT\OCOK;
  4 | 
  5 | use BeyondIT\OCOK\Helpers\Downloader;
  6 | use BeyondIT\OCOK\Helpers\FileSystem;
  7 | use BeyondIT\OCOK\Helpers\Installer;
  8 | use BeyondIT\OCOK\OCOKCommand;
  9 | use Symfony\Component\Console\Input\InputInterface;
 10 | use Symfony\Component\Console\Output\OutputInterface;
 11 | use Symfony\Component\Console\Input\InputArgument;
 12 | use Symfony\Component\Console\Input\InputOption;
 13 | 
 14 | class InstallCommand extends OCOKCommand {
 15 | 
 16 |     public function supportedVersions() {
 17 |         return array("2");
 18 |     }
 19 | 
 20 |     protected function configure() {
 21 |         $this->setName("install")
 22 |             ->setDescription("Install OpenCart")
 23 |             ->addOption("download_version","O",InputOption::VALUE_OPTIONAL,"Download OpenCart Version (e.g.: 2.0.1.1)","2.0.1.1")
 24 |             ->addOption("db_driver","d",InputOption::VALUE_OPTIONAL,"Database Drive, defaults to mysqli","mysqli")
 25 |             ->addOption("db_hostname","o",InputOption::VALUE_OPTIONAL,"Database Hostname, defaults to localhost","localhost")
 26 |             ->addOption("db_username","u",InputOption::VALUE_REQUIRED,"Database Username")
 27 |             ->addOption("db_password","p",InputOption::VALUE_REQUIRED,"Database Password")
 28 |             ->addOption("db_database","b",InputOption::VALUE_OPTIONAL,"Database Name, defaults to opencart","opencart")
 29 |             ->addOption("db_prefix","x",InputOption::VALUE_OPTIONAL,"Database Prefix, oc_ as default","oc_")
 30 |             ->addOption("username","U",InputOption::VALUE_OPTIONAL,"OpenCart Admin Username","admin")
 31 |             ->addOption("password","P",InputOption::VALUE_REQUIRED,"OpenCart Admin Password")
 32 |             ->addOption("email","e",InputOption::VALUE_REQUIRED,"OpenCart Admin Email")
 33 |             ->addOption("http_server","s",InputOption::VALUE_OPTIONAL,"HTTP Server, defaults to http://localhost/opencart/","http://localhost/opencart/");
 34 |     }
 35 | 
 36 |     protected function execute(InputInterface $input, OutputInterface $output) {
 37 |         $fsh = new FileSystem();
 38 |         $dir = getcwd();
 39 | 
 40 |         $installer = new Installer($dir . DIRECTORY_SEPARATOR);
 41 | 
 42 |         $options = array();
 43 |         $options['db_driver']   = $input->getOption("db_driver");
 44 |         $options['db_hostname'] = $input->getOption("db_hostname");
 45 |         $options['db_username'] = $input->getOption("db_username");
 46 |         $options['db_password'] = $input->getOption("db_password");
 47 |         $options['db_database'] = $input->getOption("db_database");
 48 |         $options['db_prefix']   = $input->getOption("db_prefix");
 49 |         $options['username']    = $input->getOption("username");
 50 |         $options['password']    = $input->getOption("password");
 51 |         $options['email']       = $input->getOption("email");
 52 |         $options['http_server'] = $input->getOption("http_server");
 53 | 
 54 |         if (!$options['db_username']) {
 55 |             $output->writeln("<error>Database Username option is missing!</error>");
 56 |             return;
 57 |         }
 58 | 
 59 |         if (!$options['db_password']) {
 60 |             $output->writeln("<error>Database Password option is missing!</error>");
 61 |             return;
 62 |         }
 63 | 
 64 |         if (!$options['username']) {
 65 |             $output->writeln("<error>Username option is missing!</error>");
 66 |             return;
 67 |         }
 68 | 
 69 |         if (!$options['password']) {
 70 |             $output->writeln("<error>Password option is missing!</error>");
 71 |             return;
 72 |         }
 73 | 
 74 |         if (!$options['email']) {
 75 |             $output->writeln("<error>Email option is missing!</error>");
 76 |             return;
 77 |         }
 78 | 
 79 |         if ($fsh->isEmptyDirectory($dir)) {
 80 |             $version = "2.0.1.1";
 81 |             if ($input->getOption("version")) {
 82 |                 $version = $input->getOption("version");
 83 |             }
 84 | 
 85 |             $downloader = new Downloader($dir);
 86 |             $downloader->process($version);
 87 |             $output->writeln("<info>OpenCart Version $version downloaded.</info>");
 88 |         } else if ($this->checkUninstalledOC()) { // OC present
 89 |             $version = $this->getVersion();
 90 |             $output->writeln("<info>OpenCart Version $version found.</info>");
 91 |         } else {
 92 |             $output->writeln("<error>No Empty and no OC Directory found here</error>");
 93 |             return;
 94 |         }
 95 | 
 96 |         try {
 97 |             $installer->install($options);
 98 |             $installer->removeInstallationFiles();
 99 |         } catch(\Exception $e) {
100 |             $output->writeln("<error>Error: ".$e->getMessage()."</error>");
101 |             return;
102 |         }
103 | 
104 |         $output->writeln("<info>OpenCart was successfully installed!</info>");
105 |     }
106 | 
107 | }


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     {one line to give the program's name and a brief idea of what it does.}
635 |     Copyright (C) {year}  {name of author}
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     {project}  Copyright (C) {year}  {fullname}
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 
676 | 


--------------------------------------------------------------------------------