Merge pull request #192 from tdt/development

Version 4.1.0

Author: dive-michiel

app/commands/.gitignore

@@ -0,0 +1 @@
+*.json

app/commands/Export.php

@@ -0,0 +1,150 @@
+<?php
+
+use Illuminate\Console\Command;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\InputArgument;
+
+use tdt\commands\ie\Definitions;
+use tdt\commands\ie\Users;
+use tdt\commands\ie\Groups;
+
+class Export extends Command {
+
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'datatank:export';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Export functionality for the datatank configuration. By default it exports all of the users and definitions in JSON.';
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * Ask the user which functionality he wants to use (definitions|users)
+     * then based on the input, proceed with the logic for chosen option.
+     *
+     * This option is given as an input argument upon making the command.
+     *
+     * @return void
+     */
+    public function fire()
+    {
+        // Check for filename
+        $filename = $this->option('file');
+
+        // Get the optional identifier
+        $identifier = $this->argument('identifier');
+
+        // Create new object for the export data;
+        $export_data = new \stdClass();
+
+
+        if($this->option('definitions')){
+
+            $export_data->definitions = Definitions::export($identifier);
+
+            if(!empty($identifier)){
+
+                // When the identifier doesn't check out, give the user another chance to fill it out
+                while(empty($export_data->definitions)){
+
+                    $this->error("The resource with identifier '$identifier' could not be found.");
+
+                    // Prompt new indentifier
+                    $identifier = $this->ask('Provide the full identifier of the definition you want (e.g. csv/cities): ');
+
+                    // Check if the resource id is legit
+                    $export_data->definitions = Definitions::export($identifier);
+                }
+            }
+
+        }elseif($this->option('users')){
+
+            // Export users
+            $export_data->users = Users::export();
+            // Export groups
+            $export_data->groups = Groups::export();
+
+        }else{
+
+            // Export definitions
+            $export_data->definitions = Definitions::export();
+
+            // Export users
+            $export_data->users = Users::export();
+            // Export groups
+            $export_data->groups = Groups::export();
+        }
+
+
+        // JSON encode
+        if (defined('JSON_PRETTY_PRINT')) {
+            $export_data = json_encode($export_data, JSON_PRETTY_PRINT);
+        }else{
+            $export_data = json_encode($export_data);
+        }
+        // JSON_UNESCAPED_SLASHES only available in PHP 5.4
+        $export_data = str_replace('\/', '/', $export_data);
+
+
+        // Output
+        if(empty($filename)){
+            // Print to console
+            echo $export_data;
+        }else{
+            try{
+                // Write to file
+                file_put_contents($filename, $export_data);
+                $this->info("The export has been written to the file '$filename'.");
+            }catch(Exception $e){
+                $this->error("The contents could not be written to the file '$filename'.");
+                die();
+            }
+        }
+
+    }
+
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getArguments()
+    {
+        return array(
+            array('identifier', InputArgument::OPTIONAL, 'If you specify the option -d, you can export a single definition by specifying the indentifier of that definition (e.g. csv/cities)'),
+        );
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return array(
+            array('definitions', 'd', InputOption::VALUE_NONE, 'Only export the definitions, if you specify an identifier only that definition will be exported.', null),
+            array('users', 'u', InputOption::VALUE_NONE, 'Only export the users.', null),
+            array('file', 'f', InputOption::VALUE_OPTIONAL, 'Write the export data to a file.', null),
+        );
+    }
+
+}

app/commands/Import.php

@@ -0,0 +1,149 @@
+<?php
+
+use Illuminate\Console\Command;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\InputArgument;
+use Illuminate\Filesystem\Filesystem;
+
+use tdt\commands\ie\Definitions;
+use tdt\commands\ie\Users;
+use tdt\commands\ie\Groups;
+
+class Import extends Command {
+
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'datatank:import';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Import functionality for a datatank configuration, can import users and resources passed in a JSON file.';
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function fire()
+    {
+
+        // Fetch the json file from the arguments
+        $file = $this->argument('file');
+
+        // Check if the file exists
+        if(\File::exists($file)){
+
+            // JSON decode
+            $content = json_decode(\File::get($file), true);
+
+            if($content){
+
+                // Check for user & groups
+                if(!empty($content['users']) && is_array($content['users'])
+                    && !empty($content['groups']) && is_array($content['groups'])){
+
+                    $this->info("\n——————————————————————————————————");
+                    $this->info("Users & groups found, importing...");
+                    $this->info("——————————————————————————————————");
+
+                    // Import groups
+                    $messages = Groups::import($content['groups']);
+
+                    foreach($messages as $group => $status){
+                        if($status){
+                            $this->info("• Group '$group' succesfully added.");
+                        }else{
+                            $this->error("• Group '$group' already existed, ignored.");
+                        }
+                    }
+
+                    // Import users
+                    $messages = Users::import($content['users']);
+
+                    foreach($messages as $user => $status){
+                        if($status){
+                            $this->info("• User '$user' succesfully added.");
+                        }else{
+                            $this->error("• User '$user' already existed, ignored.");
+                        }
+                    }
+                }
+
+                // Check for definitions
+                if(!empty($content['definitions']) && is_array($content['definitions'])){
+
+                    $this->info("———————————————————————————————");
+                    $this->info("Definitions found, importing...");
+                    $this->info("———————————————————————————————");
+
+                    // Ask for a set of credentials that have definition-create permissions
+                    $username = $this->ask("Enter a username that has permission to create definitions: ");
+                    $password = $this->secret("Enter the corresponding password: ");
+
+                    $data = array();
+                    $data['username'] = $username;
+                    $data['password'] = $password;
+                    $data['definitions'] = $content['definitions'];
+
+                    $messages = Definitions::import($data);
+
+                    foreach($messages as $identifier => $status){
+                        if($status){
+                            $this->info("• Definition with '$identifier' succesfully added.");
+                        }else{
+                            $this->error("Something went wrong when trying to adding the definition '$identifier', check the logs for indications of what may have gone wrong.");
+                        }
+                    }
+                }
+
+                $this->info("\nCompleted task");
+            }else{
+                $this->error("The given file doesn't contain valid JSON.");
+                die();
+            }
+        }else{
+            $this->error("The given file '$file' can't be found on the system.");
+            die();
+        }
+    }
+
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getArguments()
+    {
+        return array(
+            array("file", InputArgument::REQUIRED, "The path to the JSON export file.", null),
+        );
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return array(
+        );
+    }
+
+}

app/commands/ie/Definitions.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace tdt\commands\ie;
+
+use tdt\core\definitions\DefinitionController;
+
+/**
+ * Import/export definitions
+ * @copyright (C) 2011,2013 by OKFN Belgium vzw/asbl
+ * @license AGPLv3
+ * @author Michiel Vancoillie <[email protected]>
+ */
+class Definitions implements IImportExport {
+
+    public static function import($data){
+
+        $definitions = $data['definitions'];
+        $username = $data['username'];
+        $password = $data['password'];
+
+        // Basic auth header
+        $auth_header = "Basic " . base64_encode(trim($username) . ":" . trim($password));
+
+        $messages = array();
+
+        foreach($definitions as $identifier => $definition_params){
+
+            $headers = array(
+                            'Content-Type' => 'application/tdt.definition+json',
+                            'Authorization' => $auth_header,
+                        );
+
+            self::updateRequest('PUT', $headers, $definition_params);
+
+            // Add the new definition
+            $response = DefinitionController::handle($identifier);
+            $status_code = $response->getStatusCode();
+
+            $messages[$identifier] = ($status_code == 200);
+        }
+
+        return $messages;
+
+    }
+
+    public static function export($identifier = null){
+        if(empty($identifier)){
+            // Request all of the definitions
+            return DefinitionController::getAllDefinitions();
+        }else{
+            // Request a single definition
+            $definition =  DefinitionController::get($identifier);
+            return array($identifier => $definition->getAllParameters());
+        }
+    }
+
+
+    /**
+     * Custom API call function
+     */
+    public static function updateRequest($method, $headers = array(), $data = array()){
+
+        // Set the custom headers.
+        \Request::getFacadeRoot()->headers->replace($headers);
+
+        // Set the custom method.
+        \Request::setMethod($method);
+
+        // Set the content body.
+        if(is_array($data)){
+            \Input::merge($data);
+        }
+    }
+
+}
+