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

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