phpmyadmin/libraries/plugins/export/ExportYaml.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Set of functions used to build YAML dumps of tables
   5  *
   6  * @package    PhpMyAdmin-Export
   7  * @subpackage YAML
   8  */
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /* Get the export interface */
  14 require_once 'libraries/plugins/ExportPlugin.class.php';
  15
  16 /**
  17  * Handles the export for the YAML format
  18  *
  19  * @package    PhpMyAdmin-Export
  20  * @subpackage YAML
  21  */
  22 class ExportYaml extends ExportPlugin
  23 {
  24     /**
  25      * Constructor
  26      */
  27     public function __construct()
  28     {
  29         $this->setProperties();
  30     }
  31
  32     /**
  33      * Sets the export YAML properties
  34      *
  35      * @return void
  36      */
  37     protected function setProperties()
  38     {
  39         $props = 'libraries/properties/';
  40         include_once "$props/plugins/ExportPluginProperties.class.php";
  41         include_once "$props/options/groups/OptionsPropertyRootGroup.class.php";
  42         include_once "$props/options/groups/OptionsPropertyMainGroup.class.php";
  43         include_once "$props/options/items/HiddenPropertyItem.class.php";
  44
  45         $exportPluginProperties = new ExportPluginProperties();
  46         $exportPluginProperties->setText('YAML');
  47         $exportPluginProperties->setExtension('yml');
  48         $exportPluginProperties->setMimeType('text/yaml');
  49         $exportPluginProperties->setForceFile(true);
  50         $exportPluginProperties->setOptionsText(__('Options'));
  51
  52         // create the root group that will be the options field for
  53         // $exportPluginProperties
  54         // this will be shown as "Format specific options"
  55         $exportSpecificOptions = new OptionsPropertyRootGroup();
  56         $exportSpecificOptions->setName("Format Specific Options");
  57
  58         // general options main group
  59         $generalOptions = new OptionsPropertyMainGroup();
  60         $generalOptions->setName("general_opts");
  61         // create primary items and add them to the group
  62         $leaf = new HiddenPropertyItem();
  63         $leaf->setName("structure_or_data");
  64         $generalOptions->addProperty($leaf);
  65         // add the main group to the root group
  66         $exportSpecificOptions->addProperty($generalOptions);
  67
  68         // set the options for the export plugin property item
  69         $exportPluginProperties->setOptions($exportSpecificOptions);
  70         $this->properties = $exportPluginProperties;
  71     }
  72
  73     /**
  74      * This method is called when any PluginManager to which the observer
  75      * is attached calls PluginManager::notify()
  76      *
  77      * @param SplSubject $subject The PluginManager notifying the observer
  78      *                            of an update.
  79      *
  80      * @return void
  81      */
  82     public function update (SplSubject $subject)
  83     {
  84     }
  85
  86     /**
  87      * Outputs export header
  88      *
  89      * @return bool Whether it succeeded
  90      */
  91     public function exportHeader ()
  92     {
  93         PMA_exportOutputHandler(
  94             '%YAML 1.1' . $GLOBALS['crlf'] . '---' . $GLOBALS['crlf']
  95         );
  96         return true;
  97     }
  98
  99     /**
 100      * Outputs export footer
 101      *
 102      * @return bool Whether it succeeded
 103      */
 104     public function exportFooter ()
 105     {
 106         PMA_exportOutputHandler('...' . $GLOBALS['crlf']);
 107         return true;
 108     }
 109
 110     /**
 111      * Outputs database header
 112      *
 113      * @param string $db Database name
 114      *
 115      * @return bool Whether it succeeded
 116      */
 117     public function exportDBHeader ($db)
 118     {
 119         return true;
 120     }
 121
 122     /**
 123      * Outputs database footer
 124      *
 125      * @param string $db Database name
 126      *
 127      * @return bool Whether it succeeded
 128      */
 129     public function exportDBFooter ($db)
 130     {
 131         return true;
 132     }
 133
 134     /**
 135      * Outputs CREATE DATABASE statement
 136      *
 137      * @param string $db Database name
 138      *
 139      * @return bool Whether it succeeded
 140      */
 141     public function exportDBCreate($db)
 142     {
 143         return true;
 144     }
 145
 146     /**
 147      * Outputs the content of a table in JSON format
 148      *
 149      * @param string $db        database name
 150      * @param string $table     table name
 151      * @param string $crlf      the end of line sequence
 152      * @param string $error_url the url to go back in case of error
 153      * @param string $sql_query SQL query for obtaining data
 154      *
 155      * @return bool Whether it succeeded
 156      */
 157     public function exportData($db, $table, $crlf, $error_url, $sql_query)
 158     {
 159         $result = PMA_DBI_query($sql_query, null, PMA_DBI_QUERY_UNBUFFERED);
 160
 161         $columns_cnt = PMA_DBI_num_fields($result);
 162         for ($i = 0; $i < $columns_cnt; $i++) {
 163             $columns[$i] = stripslashes(PMA_DBI_field_name($result, $i));
 164         }
 165         unset($i);
 166
 167         $buffer = '';
 168         $record_cnt = 0;
 169         while ($record = PMA_DBI_fetch_row($result)) {
 170             $record_cnt++;
 171
 172             // Output table name as comment if this is the first record of the table
 173             if ($record_cnt == 1) {
 174                 $buffer = '# ' . $db . '.' . $table . $crlf;
 175                 $buffer .= '-' . $crlf;
 176             } else {
 177                 $buffer = '-' . $crlf;
 178             }
 179
 180             for ($i = 0; $i < $columns_cnt; $i++) {
 181                 if (! isset($record[$i])) {
 182                     continue;
 183                 }
 184
 185                 $column = $columns[$i];
 186
 187                 if (is_null($record[$i])) {
 188                     $buffer .= '  ' . $column . ': null' . $crlf;
 189                     continue;
 190                 }
 191
 192                 if (is_numeric($record[$i])) {
 193                     $buffer .= '  ' . $column . ': '  . $record[$i] . $crlf;
 194                     continue;
 195                 }
 196
 197                 $record[$i] = str_replace(
 198                     array('\\', '"', "\n", "\r"),
 199                     array('\\\\', '\"', '\n', '\r'),
 200                     $record[$i]
 201                 );
 202                 $buffer .= '  ' . $column . ': "' . $record[$i] . '"' . $crlf;
 203             }
 204
 205             if (! PMA_exportOutputHandler($buffer)) {
 206                 return false;
 207             }
 208         }
 209         PMA_DBI_free_result($result);
 210
 211         return true;
 212     } // end getTableYAML
 213 }
 214 ?>