destinations.file.inc

  1. nittany7 modules/contrib/backup_migrate/includes/destinations.file.inc
  2. mooc7 modules/contrib/backup_migrate/includes/destinations.file.inc

A destination type for saving locally to the server.

Classes

File

modules/contrib/backup_migrate/includes/destinations.file.inc
View source
  1. <?php
  2. /**
  3. * @file
  4. * A destination type for saving locally to the server.
  5. */
  6. /**
  7. * A destination type for saving locally to the server.
  8. *
  9. * @ingroup backup_migrate_destinations
  10. */
  11. class backup_migrate_destination_files extends backup_migrate_destination {
  12. var $supported_ops = array('scheduled backup', 'manual backup', 'restore', 'list files', 'configure', 'delete');
  13. function type_name() {
  14. return t("Server Directory");
  15. }
  16. /**
  17. * Get the file location.
  18. */
  19. function get_realpath() {
  20. return drupal_realpath($this->get_location());
  21. }
  22. /**
  23. * File save destination callback.
  24. */
  25. function _save_file($file, $settings) {
  26. if ($dir = $this->get_location()) {
  27. if ($dir = $this->check_dir($dir)) {
  28. $filepath = rtrim($dir, "/") ."/". $file->filename();
  29. if (file_unmanaged_move($file->filepath(), $filepath)) {
  30. // chmod, chown and chgrp the file if needed.
  31. if ($chmod = $this->settings('chmod')) {
  32. if (!@drupal_chmod($filepath, octdec($chmod))) {
  33. _backup_migrate_message('Unable to set the file mode for: @file', array('@file' => $filepath), 'error');
  34. }
  35. }
  36. if ($chgrp = $this->settings('chgrp')) {
  37. if (!@chgrp($filepath, $chgrp)) {
  38. _backup_migrate_message('Unable to set the file group for: @file', array('@file' => $filepath), 'error');
  39. }
  40. }
  41. return $file;
  42. }
  43. else {
  44. _backup_migrate_message('Unable to save the file to the directory: @dir', array('@dir' => $dir), 'error');
  45. }
  46. }
  47. }
  48. }
  49. /**
  50. * Determine if we can read the given file.
  51. */
  52. function can_read_file($file_id) {
  53. return $this->op('restore') && is_readable($this->get_filepath($file_id));
  54. }
  55. /**
  56. * File load destination callback.
  57. */
  58. function load_file($file_id) {
  59. $filepath = $this->get_filepath($file_id);
  60. if (file_exists($filepath)) {
  61. backup_migrate_include('files');
  62. return new backup_file(array('filepath' => $filepath));
  63. }
  64. }
  65. /**
  66. * File list destination callback.
  67. */
  68. function _list_files() {
  69. $files = array();
  70. if ($dir = $this->get_realpath()) {
  71. if ($handle = @opendir($dir)) {
  72. backup_migrate_include('files');
  73. while (FALSE !== ($file = readdir($handle))) {
  74. $filepath = $dir ."/". $file;
  75. $files[$file] = new backup_file(array('filepath' => $filepath));
  76. }
  77. }
  78. }
  79. return $files;
  80. }
  81. /**
  82. * File delete destination callback.
  83. */
  84. function _delete_file($file_id) {
  85. $filepath = $this->get_filepath($file_id);
  86. file_unmanaged_delete($filepath);
  87. }
  88. /**
  89. * Get the filepath from the given file id.
  90. */
  91. function get_filepath($file_id) {
  92. if ($dir = $this->get_realpath()) {
  93. $filepath = rtrim($dir, '/') .'/'. $file_id;
  94. return $filepath;
  95. }
  96. return FALSE;
  97. }
  98. /**
  99. * Get the form for the settings for the files destination.
  100. */
  101. function edit_form() {
  102. $form = parent::edit_form();
  103. $form['location'] = array(
  104. "#type" => "textfield",
  105. "#title" => t("Directory path"),
  106. "#default_value" => $this->get_location(),
  107. "#required" => TRUE,
  108. "#description" => t('Enter the path to the directory to save the backups to. Use a relative path to pick a path relative to your Drupal root directory. The web server must be able to write to this path.'),
  109. );
  110. $form['settings'] = array(
  111. '#type' => 'fieldset',
  112. '#title' => t('Advanced Settings'),
  113. '#tree' => TRUE,
  114. '#collapsible' => TRUE,
  115. '#collapsed' => TRUE,
  116. );
  117. if (function_exists('chmod')) {
  118. $form['settings']['chmod'] = array(
  119. '#type' => 'textfield',
  120. '#title' => t('Change file mode (chmod)'),
  121. '#size' => 5,
  122. '#default_value' => $this->settings('chmod'),
  123. '#description' => t('If you enter a value here, backup files will be chmoded with the mode you specify. Specify the mode in octal form (e.g. 644 or 0644) or leave blank to disable this feature.'),
  124. );
  125. }
  126. if (function_exists('chgrp')) {
  127. $form['settings']['chgrp'] = array(
  128. '#type' => 'textfield',
  129. '#title' => t('Change file group (chgrp)'),
  130. '#size' => 5,
  131. '#default_value' => $this->settings('chgrp'),
  132. '#description' => t('If you enter a value here, backup files will be chgrped to the group you specify. Leave blank to disable this feature.'),
  133. );
  134. }
  135. return $form;
  136. }
  137. /**
  138. * Validate the form for the settings for the files destination.
  139. */
  140. function edit_form_validate($form, &$form_state) {
  141. $values = $form_state['values'];
  142. if (isset($values['settings']['chmod']) && !empty($values['settings']['chmod']) && !preg_match('/0?[0-7]{3}/', $values['settings']['chmod'])) {
  143. form_set_error('chmod', t('You must enter a valid chmod octal value (e.g. 644 or 0644) in the change mode field, or leave it blank.'));
  144. }
  145. parent::edit_form_validate($form, $form_state);
  146. }
  147. /**
  148. * Submit the form for the settings for the files destination.
  149. */
  150. function edit_form_submit($form, &$form_state) {
  151. // Add a 0 to the start of a 3 digit file mode to make it proper PHP encoded octal.
  152. if (strlen($form_state['values']['settings']['chmod']) == 3) {
  153. $form_state['values']['settings']['chmod'] = '0' . $form_state['values']['settings']['chmod'];
  154. }
  155. parent::edit_form_submit($form, $form_state);
  156. }
  157. /**
  158. * Prepare the destination directory for the backups.
  159. */
  160. function check_dir($directory) {
  161. if (!file_prepare_directory($directory, FILE_CREATE_DIRECTORY)) {
  162. // Unable to create destination directory.
  163. _backup_migrate_message("Unable to create or write to the save directory '%directory'. Please check the file permissions that directory and try again.", array('%directory' => $directory), "error");
  164. return FALSE;
  165. }
  166. // If the destination directory is within the webroot, then secure it as best we can.
  167. if ($this->dir_in_webroot($directory)) {
  168. $directory = $this->check_web_dir($directory);
  169. }
  170. return $directory;
  171. }
  172. /**
  173. * Check that a web accessible directory has been properly secured, othewise attempt to secure it.
  174. */
  175. function check_web_dir($directory) {
  176. // If the directory is specified with an absolute path, strip the site root.
  177. $directory = substr(drupal_realpath($directory), strlen(drupal_realpath($_SERVER['DOCUMENT_ROOT']) . base_path()));
  178. file_create_htaccess($directory, TRUE);
  179. // Check the user agent to make sure we're not responding to a request from drupal itself.
  180. // That should prevent infinite loops which could be caused by poormanscron in some circumstances.
  181. if (strpos($_SERVER['HTTP_USER_AGENT'], 'Drupal') !== FALSE) {
  182. return FALSE;
  183. }
  184. // Check to see if the destination is publicly accessible
  185. $test_contents = "this file should not be publicly accessible";
  186. // Create the the text.txt file if it's not already there.
  187. if (!is_file($directory .'/test.txt') || file_get_contents($directory .'/test.txt') != $test_contents) {
  188. if ($fp = fopen($directory .'/test.txt', 'w')) {
  189. @fputs($fp, $test_contents);
  190. fclose($fp);
  191. }
  192. else {
  193. $message = t("Security notice: Backup and Migrate was unable to write a test text file to the destination directory %directory, and is therefore unable to check the security of the backup destination. Backups to the server will be disabled until the destination becomes writable and secure.", array('%directory' => $directory));
  194. drupal_set_message($message, "error");
  195. return FALSE;
  196. }
  197. }
  198. // Attempt to read the test file via http. This may fail for other reasons,
  199. // so it's not a bullet-proof check.
  200. if ($this->test_file_readable_remotely($directory .'/test.txt', $test_contents)) {
  201. $message = t("Security notice: Backup and Migrate will not save backup files to the server because the destination directory is publicly accessible. If you want to save files to the server, please secure the '%directory' directory", array('%directory' => $directory));
  202. drupal_set_message($message, "error");
  203. return FALSE;
  204. }
  205. return $directory;
  206. }
  207. /**
  208. * Check if the given directory is within the webroot and is therefore web accessible.
  209. */
  210. function dir_in_webroot($directory) {
  211. if (strpos(drupal_realpath($directory), realpath($_SERVER['DOCUMENT_ROOT'])) !== FALSE) {
  212. return TRUE;
  213. }
  214. return FALSE;
  215. }
  216. /**
  217. * Check if a file can be read remotely via http.
  218. */
  219. function test_file_readable_remotely($path, $contents) {
  220. $url = $GLOBALS['base_url'] . '/' . str_replace('\\', '/', $path);
  221. $result = drupal_http_request($url);
  222. if (!empty($result->data) && strpos($result->data, $contents) !== FALSE) {
  223. return TRUE;
  224. }
  225. return FALSE;
  226. }
  227. }
  228. /**
  229. * The manual files directory.
  230. */
  231. class backup_migrate_destination_files_manual extends backup_migrate_destination_files {
  232. var $supported_ops = array('manual backup', 'restore', 'list files', 'configure', 'delete');
  233. function __construct($params = array()) {
  234. $dir = 'private://backup_migrate/manual';
  235. parent::__construct($params + array('location' => $dir, 'name' => t('Manual Backups Directory')));
  236. }
  237. }
  238. /**
  239. * The scheduled files directory.
  240. */
  241. class backup_migrate_destination_files_scheduled extends backup_migrate_destination_files {
  242. var $supported_ops = array('scheduled backup', 'restore', 'list files', 'configure', 'delete');
  243. function __construct($params = array()) {
  244. $dir = 'private://backup_migrate/scheduled';
  245. parent::__construct($params + array('location' => $dir, 'name' => t('Scheduled Backups Directory')));
  246. }
  247. }