phpmyadmin/libraries/plugins/transformations/abstract/ExternalTransformationsPlugin.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the external transformations plugins
   5  *
   6  * @package    PhpMyAdmin-Transformations
   7  * @subpackage External
   8  */
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /* Get the transformations interface */
  14 require_once 'libraries/plugins/TransformationsPlugin.class.php';
  15
  16 /**
  17  * Provides common methods for all of the external transformations plugins.
  18  *
  19  * @package PhpMyAdmin
  20  */
  21 abstract class ExternalTransformationsPlugin extends TransformationsPlugin
  22 {
  23     /**
  24      * Gets the transformation description of the specific plugin
  25      *
  26      * @return string
  27      */
  28     public static function getInfo()
  29     {
  30         return __(
  31             'LINUX ONLY: Launches an external application and feeds it the column'
  32             . ' data via standard input. Returns the standard output of the'
  33             . ' application. The default is Tidy, to pretty-print HTML code.'
  34             . ' For security reasons, you have to manually edit the file'
  35             . ' libraries/plugins/transformations/Text_Plain_External'
  36             . '.class.php and list the tools you want to make available.'
  37             . ' The first option is then the number of the program you want to'
  38             . ' use and the second option is the parameters for the program.'
  39             . ' The third option, if set to 1, will convert the output using'
  40             . ' htmlspecialchars() (Default 1). The fourth option, if set to 1,'
  41             . ' will prevent wrapping and ensure that the output appears all on'
  42             . ' one line (Default 1).'
  43         );
  44     }
  45
  46     /**
  47      * Enables no-wrapping
  48      *
  49      * @param array $options transformation options
  50      *
  51      * @return bool
  52      */
  53     public function applyTransformationNoWrap($options = array())
  54     {
  55         if (! isset($options[3]) || $options[3] == '') {
  56             $nowrap = true;
  57         } elseif ($options[3] == '1' || $options[3] == 1) {
  58             $nowrap = true;
  59         } else {
  60             $nowrap = false;
  61         }
  62
  63         return $nowrap;
  64     }
  65
  66     /**
  67      * Does the actual work of each specific transformations plugin.
  68      *
  69      * @param string $buffer  text to be transformed
  70      * @param array  $options transformation options
  71      * @param string $meta    meta information
  72      *
  73      * @return void
  74      */
  75     public function applyTransformation($buffer, $options = array(), $meta = '')
  76     {
  77         // possibly use a global transform and feed it with special options
  78
  79         // further operations on $buffer using the $options[] array.
  80
  81         $allowed_programs = array();
  82
  83         //
  84         // WARNING:
  85         //
  86         // It's up to administrator to allow anything here. Note that users may
  87         // specify any parameters, so when programs allow output redirection or
  88         // any other possibly dangerous operations, you should write wrapper
  89         // script that will publish only functions you really want.
  90         //
  91         // Add here program definitions like (note that these are NOT safe
  92         // programs):
  93         //
  94         //$allowed_programs[0] = '/usr/local/bin/tidy';
  95         //$allowed_programs[1] = '/usr/local/bin/validate';
  96
  97         // no-op when no allowed programs
  98         if (count($allowed_programs) == 0) {
  99             return $buffer;
 100         }
 101
 102         if (! isset($options[0])
 103             || $options[0] == ''
 104             || ! isset($allowed_programs[$options[0]])
 105         ) {
 106             $program = $allowed_programs[0];
 107         } else {
 108             $program = $allowed_programs[$options[0]];
 109         }
 110
 111         if (!isset($options[1]) || $options[1] == '') {
 112             $poptions = '-f /dev/null -i -wrap -q';
 113         } else {
 114             $poptions = $options[1];
 115         }
 116
 117         if (!isset($options[2]) || $options[2] == '') {
 118             $options[2] = 1;
 119         }
 120
 121         if (!isset($options[3]) || $options[3] == '') {
 122             $options[3] = 1;
 123         }
 124
 125         // needs PHP >= 4.3.0
 126         $newstring = '';
 127         $descriptorspec = array(
 128             0 => array("pipe", "r"),
 129             1 => array("pipe", "w")
 130         );
 131         $process = proc_open($program . ' ' . $poptions, $descriptorspec, $pipes);
 132         if (is_resource($process)) {
 133             fwrite($pipes[0], $buffer);
 134             fclose($pipes[0]);
 135
 136             while (!feof($pipes[1])) {
 137                 $newstring .= fgets($pipes[1], 1024);
 138             }
 139             fclose($pipes[1]);
 140             // we don't currently use the return value
 141             proc_close($process);
 142         }
 143
 144         if ($options[2] == 1 || $options[2] == '2') {
 145             $retstring = htmlspecialchars($newstring);
 146         } else {
 147             $retstring = $newstring;
 148         }
 149
 150         return $retstring;
 151     }
 152
 153     /**
 154      * This method is called when any PluginManager to which the observer
 155      * is attached calls PluginManager::notify()
 156      *
 157      * @param SplSubject $subject The PluginManager notifying the observer
 158      *                            of an update.
 159      *
 160      * @todo implement
 161      * @return void
 162      */
 163     public function update (SplSubject $subject)
 164     {
 165         ;
 166     }
 167
 168
 169     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
 170
 171
 172     /**
 173      * Gets the transformation name of the specific plugin
 174      *
 175      * @return string
 176      */
 177     public static function getName()
 178     {
 179         return "External";
 180     }
 181 }
 182 ?>