libraries/display_import_ajax.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4 * Handles plugins that show the upload progress
   5 *
   6 * @package PhpMyAdmin
   7 */
   8
   9 /**
  10  * Sets up some variables for upload progress
  11  *
  12  * @return array
  13  *
  14  */
  15 function PMA_uploadProgressSetup()
  16 {
  17     /**
  18      * constant for differentiating array in $_SESSION variable
  19      */
  20     $SESSION_KEY = '__upload_status';
  21
  22     /**
  23      * sets default plugin for handling the import process
  24      */
  25     $_SESSION[$SESSION_KEY]["handler"] = "";
  26
  27     /**
  28      * unique ID for each upload
  29      */
  30     $upload_id = uniqid("");
  31
  32     /**
  33      * list of available plugins
  34      *
  35      * Each plugin has own checkfunction in display_import_ajax.lib.php
  36      * and own file with functions in upload_#KEY#.php
  37      */
  38     $plugins = array(
  39         // PHP 5.4 session-based upload progress is problematic, see bug 3964
  40         //"session",
  41         "progress",
  42         "apc",
  43         "noplugin"
  44     );
  45
  46     // select available plugin
  47     foreach ($plugins as $plugin) {
  48         $check = "PMA_Import_" . $plugin . "Check";
  49
  50         if ($check()) {
  51             $upload_class = 'PMA\libraries\plugins\import\upload\Upload' . ucwords(
  52                 $plugin
  53             );
  54             $_SESSION[$SESSION_KEY]["handler"] = $upload_class;
  55             break;
  56         }
  57     }
  58     return array($SESSION_KEY, $upload_id, $plugins);
  59 }
  60
  61 /**
  62   * Checks if APC bar extension is available and configured correctly.
  63   *
  64   * @return boolean true if APC extension is available and if rfc1867 is enabled,
  65   *                      false if it is not
  66   */
  67 function PMA_Import_apcCheck()
  68 {
  69     if (! extension_loaded('apc')
  70         || ! function_exists('apc_fetch')
  71         || ! function_exists('getallheaders')
  72     ) {
  73         return false;
  74     }
  75     return (ini_get('apc.enabled') && ini_get('apc.rfc1867'));
  76 }
  77
  78 /**
  79  * Checks if PMA\libraries\plugins\import\upload\UploadProgress bar extension is
  80  * available.
  81  *
  82  * @return boolean true if PMA\libraries\plugins\import\upload\UploadProgress
  83  * extension is available, false if it is not
  84  */
  85 function PMA_Import_progressCheck()
  86 {
  87     if (! function_exists("uploadprogress_get_info")
  88         || ! function_exists('getallheaders')
  89     ) {
  90         return false;
  91     }
  92     return true;
  93 }
  94
  95 /**
  96   * Checks if PHP 5.4 session upload-progress feature is available.
  97   *
  98   * @return boolean true if PHP 5.4 session upload-progress is available,
  99   *                 false if it is not
 100   */
 101 function PMA_Import_sessionCheck()
 102 {
 103     if (! ini_get('session.upload_progress.enabled')) {
 104         return false;
 105     }
 106     return true;
 107 }
 108
 109 /**
 110   * Default plugin for handling import.
 111   * If no other plugin is available, noplugin is used.
 112   *
 113   * @return boolean true
 114   */
 115 function PMA_Import_nopluginCheck()
 116 {
 117     return true;
 118 }
 119
 120 /**
 121   * The function outputs json encoded status of uploaded.
 122   * It uses PMA_getUploadStatus, which is defined in plugin's file.
 123   *
 124   * @param string $id ID of transfer, usually $upload_id
 125   *                   from display_import_ajax.lib.php
 126   *
 127   * @return void
 128   */
 129 function PMA_importAjaxStatus($id)
 130 {
 131     PMA_headerJSON();
 132     echo json_encode(
 133         $_SESSION[$GLOBALS['SESSION_KEY']]['handler']::getUploadStatus($id)
 134     );
 135 }