file.inc 87 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501
  1. <?php
  2. /**
  3. * @file
  4. * API for handling file uploads and server file management.
  5. */
  6. /**
  7. * Manually include stream wrapper code.
  8. *
  9. * Stream wrapper code is included here because there are cases where
  10. * File API is needed before a bootstrap, or in an alternate order (e.g.
  11. * maintenance theme).
  12. */
  13. require_once DRUPAL_ROOT . '/includes/stream_wrappers.inc';
  14. /**
  15. * @defgroup file File interface
  16. * @{
  17. * Common file handling functions.
  18. *
  19. * Fields on the file object:
  20. * - fid: File ID
  21. * - uid: The {users}.uid of the user who is associated with the file.
  22. * - filename: Name of the file with no path components. This may differ from
  23. * the basename of the filepath if the file is renamed to avoid overwriting
  24. * an existing file.
  25. * - uri: URI of the file.
  26. * - filemime: The file's MIME type.
  27. * - filesize: The size of the file in bytes.
  28. * - status: A bitmapped field indicating the status of the file. The first 8
  29. * bits are reserved for Drupal core. The least significant bit indicates
  30. * temporary (0) or permanent (1). Temporary files older than
  31. * DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed during cron runs.
  32. * - timestamp: UNIX timestamp for the date the file was added to the database.
  33. */
  34. /**
  35. * Flag used by file_prepare_directory() -- create directory if not present.
  36. */
  37. define('FILE_CREATE_DIRECTORY', 1);
  38. /**
  39. * Flag used by file_prepare_directory() -- file permissions may be changed.
  40. */
  41. define('FILE_MODIFY_PERMISSIONS', 2);
  42. /**
  43. * Flag for dealing with existing files: Appends number until name is unique.
  44. */
  45. define('FILE_EXISTS_RENAME', 0);
  46. /**
  47. * Flag for dealing with existing files: Replace the existing file.
  48. */
  49. define('FILE_EXISTS_REPLACE', 1);
  50. /**
  51. * Flag for dealing with existing files: Do nothing and return FALSE.
  52. */
  53. define('FILE_EXISTS_ERROR', 2);
  54. /**
  55. * Indicates that the file is permanent and should not be deleted.
  56. *
  57. * Temporary files older than DRUPAL_MAXIMUM_TEMP_FILE_AGE will be removed
  58. * during cron runs, but permanent files will not be removed during the file
  59. * garbage collection process.
  60. */
  61. define('FILE_STATUS_PERMANENT', 1);
  62. /**
  63. * Provides Drupal stream wrapper registry.
  64. *
  65. * A stream wrapper is an abstraction of a file system that allows Drupal to
  66. * use the same set of methods to access both local files and remote resources.
  67. *
  68. * Provide a facility for managing and querying user-defined stream wrappers
  69. * in PHP. PHP's internal stream_get_wrappers() doesn't return the class
  70. * registered to handle a stream, which we need to be able to find the handler
  71. * for class instantiation.
  72. *
  73. * If a module registers a scheme that is already registered with PHP, the
  74. * existing scheme will be unregistered and replaced with the specified class.
  75. *
  76. * A stream is referenced as "scheme://target".
  77. *
  78. * The optional $filter parameter can be used to retrieve only the stream
  79. * wrappers that are appropriate for particular usage. For example, this returns
  80. * only stream wrappers that use local file storage:
  81. * @code
  82. * $local_stream_wrappers = file_get_stream_wrappers(STEAM_WRAPPERS_LOCAL);
  83. * @endcode
  84. *
  85. * The $filter parameter can only filter to types containing a particular flag.
  86. * In some cases, you may want to filter to types that do not contain a
  87. * particular flag. For example, you may want to retrieve all stream wrappers
  88. * that are not writable, or all stream wrappers that are not local. PHP's
  89. * array_diff_key() function can be used to help with this. For example, this
  90. * returns only stream wrappers that do not use local file storage:
  91. * @code
  92. * $remote_stream_wrappers = array_diff_key(file_get_stream_wrappers(STREAM_WRAPPERS_ALL), file_get_stream_wrappers(STEAM_WRAPPERS_LOCAL));
  93. * @endcode
  94. *
  95. * @param $filter
  96. * (Optional) Filters out all types except those with an on bit for each on
  97. * bit in $filter. For example, if $filter is STREAM_WRAPPERS_WRITE_VISIBLE,
  98. * which is equal to (STREAM_WRAPPERS_READ | STREAM_WRAPPERS_WRITE |
  99. * STREAM_WRAPPERS_VISIBLE), then only stream wrappers with all three of these
  100. * bits set are returned. Defaults to STREAM_WRAPPERS_ALL, which returns all
  101. * registered stream wrappers.
  102. *
  103. * @return
  104. * An array keyed by scheme, with values containing an array of information
  105. * about the stream wrapper, as returned by hook_stream_wrappers(). If $filter
  106. * is omitted or set to STREAM_WRAPPERS_ALL, the entire Drupal stream wrapper
  107. * registry is returned. Otherwise only the stream wrappers whose 'type'
  108. * bitmask has an on bit for each bit specified in $filter are returned.
  109. *
  110. * @see hook_stream_wrappers()
  111. * @see hook_stream_wrappers_alter()
  112. */
  113. function file_get_stream_wrappers($filter = STREAM_WRAPPERS_ALL) {
  114. $wrappers_storage = &drupal_static(__FUNCTION__);
  115. if (!isset($wrappers_storage)) {
  116. $wrappers = module_invoke_all('stream_wrappers');
  117. foreach ($wrappers as $scheme => $info) {
  118. // Add defaults.
  119. $wrappers[$scheme] += array('type' => STREAM_WRAPPERS_NORMAL);
  120. }
  121. drupal_alter('stream_wrappers', $wrappers);
  122. $existing = stream_get_wrappers();
  123. foreach ($wrappers as $scheme => $info) {
  124. // We only register classes that implement our interface.
  125. if (in_array('DrupalStreamWrapperInterface', class_implements($info['class']), TRUE)) {
  126. // Record whether we are overriding an existing scheme.
  127. if (in_array($scheme, $existing, TRUE)) {
  128. $wrappers[$scheme]['override'] = TRUE;
  129. stream_wrapper_unregister($scheme);
  130. }
  131. else {
  132. $wrappers[$scheme]['override'] = FALSE;
  133. }
  134. if (($info['type'] & STREAM_WRAPPERS_LOCAL) == STREAM_WRAPPERS_LOCAL) {
  135. stream_wrapper_register($scheme, $info['class']);
  136. }
  137. else {
  138. stream_wrapper_register($scheme, $info['class'], STREAM_IS_URL);
  139. }
  140. }
  141. // Pre-populate the static cache with the filters most typically used.
  142. $wrappers_storage[STREAM_WRAPPERS_ALL][$scheme] = $wrappers[$scheme];
  143. if (($info['type'] & STREAM_WRAPPERS_WRITE_VISIBLE) == STREAM_WRAPPERS_WRITE_VISIBLE) {
  144. $wrappers_storage[STREAM_WRAPPERS_WRITE_VISIBLE][$scheme] = $wrappers[$scheme];
  145. }
  146. }
  147. }
  148. if (!isset($wrappers_storage[$filter])) {
  149. $wrappers_storage[$filter] = array();
  150. foreach ($wrappers_storage[STREAM_WRAPPERS_ALL] as $scheme => $info) {
  151. // Bit-wise filter.
  152. if (($info['type'] & $filter) == $filter) {
  153. $wrappers_storage[$filter][$scheme] = $info;
  154. }
  155. }
  156. }
  157. return $wrappers_storage[$filter];
  158. }
  159. /**
  160. * Returns the stream wrapper class name for a given scheme.
  161. *
  162. * @param $scheme
  163. * Stream scheme.
  164. *
  165. * @return
  166. * Return string if a scheme has a registered handler, or FALSE.
  167. */
  168. function file_stream_wrapper_get_class($scheme) {
  169. $wrappers = file_get_stream_wrappers();
  170. return empty($wrappers[$scheme]) ? FALSE : $wrappers[$scheme]['class'];
  171. }
  172. /**
  173. * Returns the scheme of a URI (e.g. a stream).
  174. *
  175. * @param $uri
  176. * A stream, referenced as "scheme://target".
  177. *
  178. * @return
  179. * A string containing the name of the scheme, or FALSE if none. For example,
  180. * the URI "public://example.txt" would return "public".
  181. *
  182. * @see file_uri_target()
  183. */
  184. function file_uri_scheme($uri) {
  185. $position = strpos($uri, '://');
  186. return $position ? substr($uri, 0, $position) : FALSE;
  187. }
  188. /**
  189. * Checks that the scheme of a stream URI is valid.
  190. *
  191. * Confirms that there is a registered stream handler for the provided scheme
  192. * and that it is callable. This is useful if you want to confirm a valid
  193. * scheme without creating a new instance of the registered handler.
  194. *
  195. * @param $scheme
  196. * A URI scheme, a stream is referenced as "scheme://target".
  197. *
  198. * @return
  199. * Returns TRUE if the string is the name of a validated stream,
  200. * or FALSE if the scheme does not have a registered handler.
  201. */
  202. function file_stream_wrapper_valid_scheme($scheme) {
  203. // Does the scheme have a registered handler that is callable?
  204. $class = file_stream_wrapper_get_class($scheme);
  205. if (class_exists($class)) {
  206. return TRUE;
  207. }
  208. else {
  209. return FALSE;
  210. }
  211. }
  212. /**
  213. * Returns the part of a URI after the schema.
  214. *
  215. * @param $uri
  216. * A stream, referenced as "scheme://target".
  217. *
  218. * @return
  219. * A string containing the target (path), or FALSE if none.
  220. * For example, the URI "public://sample/test.txt" would return
  221. * "sample/test.txt".
  222. *
  223. * @see file_uri_scheme()
  224. */
  225. function file_uri_target($uri) {
  226. $data = explode('://', $uri, 2);
  227. // Remove erroneous leading or trailing, forward-slashes and backslashes.
  228. return count($data) == 2 ? trim($data[1], '\/') : FALSE;
  229. }
  230. /**
  231. * Gets the default file stream implementation.
  232. *
  233. * @return
  234. * 'public', 'private' or any other file scheme defined as the default.
  235. */
  236. function file_default_scheme() {
  237. return variable_get('file_default_scheme', 'public');
  238. }
  239. /**
  240. * Normalizes a URI by making it syntactically correct.
  241. *
  242. * A stream is referenced as "scheme://target".
  243. *
  244. * The following actions are taken:
  245. * - Remove trailing slashes from target
  246. * - Trim erroneous leading slashes from target. e.g. ":///" becomes "://".
  247. *
  248. * @param $uri
  249. * String reference containing the URI to normalize.
  250. *
  251. * @return
  252. * The normalized URI.
  253. */
  254. function file_stream_wrapper_uri_normalize($uri) {
  255. $scheme = file_uri_scheme($uri);
  256. if ($scheme && file_stream_wrapper_valid_scheme($scheme)) {
  257. $target = file_uri_target($uri);
  258. if ($target !== FALSE) {
  259. $uri = $scheme . '://' . $target;
  260. }
  261. }
  262. else {
  263. // The default scheme is file://
  264. $url = 'file://' . $uri;
  265. }
  266. return $uri;
  267. }
  268. /**
  269. * Returns a reference to the stream wrapper class responsible for a given URI.
  270. *
  271. * The scheme determines the stream wrapper class that should be
  272. * used by consulting the stream wrapper registry.
  273. *
  274. * @param $uri
  275. * A stream, referenced as "scheme://target".
  276. *
  277. * @return
  278. * Returns a new stream wrapper object appropriate for the given URI or FALSE
  279. * if no registered handler could be found. For example, a URI of
  280. * "private://example.txt" would return a new private stream wrapper object
  281. * (DrupalPrivateStreamWrapper).
  282. */
  283. function file_stream_wrapper_get_instance_by_uri($uri) {
  284. $scheme = file_uri_scheme($uri);
  285. $class = file_stream_wrapper_get_class($scheme);
  286. if (class_exists($class)) {
  287. $instance = new $class();
  288. $instance->setUri($uri);
  289. return $instance;
  290. }
  291. else {
  292. return FALSE;
  293. }
  294. }
  295. /**
  296. * Returns a reference to the stream wrapper class responsible for a scheme.
  297. *
  298. * This helper method returns a stream instance using a scheme. That is, the
  299. * passed string does not contain a "://". For example, "public" is a scheme
  300. * but "public://" is a URI (stream). This is because the later contains both
  301. * a scheme and target despite target being empty.
  302. *
  303. * Note: the instance URI will be initialized to "scheme://" so that you can
  304. * make the customary method calls as if you had retrieved an instance by URI.
  305. *
  306. * @param $scheme
  307. * If the stream was "public://target", "public" would be the scheme.
  308. *
  309. * @return
  310. * Returns a new stream wrapper object appropriate for the given $scheme.
  311. * For example, for the public scheme a stream wrapper object
  312. * (DrupalPublicStreamWrapper).
  313. * FALSE is returned if no registered handler could be found.
  314. */
  315. function file_stream_wrapper_get_instance_by_scheme($scheme) {
  316. $class = file_stream_wrapper_get_class($scheme);
  317. if (class_exists($class)) {
  318. $instance = new $class();
  319. $instance->setUri($scheme . '://');
  320. return $instance;
  321. }
  322. else {
  323. return FALSE;
  324. }
  325. }
  326. /**
  327. * Creates a web-accessible URL for a stream to an external or local file.
  328. *
  329. * Compatibility: normal paths and stream wrappers.
  330. *
  331. * There are two kinds of local files:
  332. * - "managed files", i.e. those stored by a Drupal-compatible stream wrapper.
  333. * These are files that have either been uploaded by users or were generated
  334. * automatically (for example through CSS aggregation).
  335. * - "shipped files", i.e. those outside of the files directory, which ship as
  336. * part of Drupal core or contributed modules or themes.
  337. *
  338. * @param $uri
  339. * The URI to a file for which we need an external URL, or the path to a
  340. * shipped file.
  341. *
  342. * @return
  343. * A string containing a URL that may be used to access the file.
  344. * If the provided string already contains a preceding 'http', 'https', or
  345. * '/', nothing is done and the same string is returned. If a stream wrapper
  346. * could not be found to generate an external URL, then FALSE is returned.
  347. *
  348. * @see http://drupal.org/node/515192
  349. */
  350. function file_create_url($uri) {
  351. // Allow the URI to be altered, e.g. to serve a file from a CDN or static
  352. // file server.
  353. drupal_alter('file_url', $uri);
  354. $scheme = file_uri_scheme($uri);
  355. if (!$scheme) {
  356. // Allow for:
  357. // - root-relative URIs (e.g. /foo.jpg in http://example.com/foo.jpg)
  358. // - protocol-relative URIs (e.g. //bar.jpg, which is expanded to
  359. // http://example.com/bar.jpg by the browser when viewing a page over
  360. // HTTP and to https://example.com/bar.jpg when viewing a HTTPS page)
  361. // Both types of relative URIs are characterized by a leading slash, hence
  362. // we can use a single check.
  363. if (drupal_substr($uri, 0, 1) == '/') {
  364. return $uri;
  365. }
  366. else {
  367. // If this is not a properly formatted stream, then it is a shipped file.
  368. // Therefore, return the urlencoded URI with the base URL prepended.
  369. return $GLOBALS['base_url'] . '/' . drupal_encode_path($uri);
  370. }
  371. }
  372. elseif ($scheme == 'http' || $scheme == 'https') {
  373. // Check for http so that we don't have to implement getExternalUrl() for
  374. // the http wrapper.
  375. return $uri;
  376. }
  377. else {
  378. // Attempt to return an external URL using the appropriate wrapper.
  379. if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) {
  380. return $wrapper->getExternalUrl();
  381. }
  382. else {
  383. return FALSE;
  384. }
  385. }
  386. }
  387. /**
  388. * Checks that the directory exists and is writable.
  389. *
  390. * Directories need to have execute permissions to be considered a directory by
  391. * FTP servers, etc.
  392. *
  393. * @param $directory
  394. * A string reference containing the name of a directory path or URI. A
  395. * trailing slash will be trimmed from a path.
  396. * @param $options
  397. * A bitmask to indicate if the directory should be created if it does
  398. * not exist (FILE_CREATE_DIRECTORY) or made writable if it is read-only
  399. * (FILE_MODIFY_PERMISSIONS).
  400. *
  401. * @return
  402. * TRUE if the directory exists (or was created) and is writable. FALSE
  403. * otherwise.
  404. */
  405. function file_prepare_directory(&$directory, $options = FILE_MODIFY_PERMISSIONS) {
  406. if (!file_stream_wrapper_valid_scheme(file_uri_scheme($directory))) {
  407. // Only trim if we're not dealing with a stream.
  408. $directory = rtrim($directory, '/\\');
  409. }
  410. // Check if directory exists.
  411. if (!is_dir($directory)) {
  412. // Let mkdir() recursively create directories and use the default directory
  413. // permissions.
  414. if (($options & FILE_CREATE_DIRECTORY) && @drupal_mkdir($directory, NULL, TRUE)) {
  415. return drupal_chmod($directory);
  416. }
  417. return FALSE;
  418. }
  419. // The directory exists, so check to see if it is writable.
  420. $writable = is_writable($directory);
  421. if (!$writable && ($options & FILE_MODIFY_PERMISSIONS)) {
  422. return drupal_chmod($directory);
  423. }
  424. return $writable;
  425. }
  426. /**
  427. * Creates a .htaccess file in each Drupal files directory if it is missing.
  428. */
  429. function file_ensure_htaccess() {
  430. file_create_htaccess('public://', FALSE);
  431. if (variable_get('file_private_path', FALSE)) {
  432. file_create_htaccess('private://', TRUE);
  433. }
  434. file_create_htaccess('temporary://', TRUE);
  435. }
  436. /**
  437. * Creates a .htaccess file in the given directory.
  438. *
  439. * @param $directory
  440. * The directory.
  441. * @param $private
  442. * FALSE indicates that $directory should be an open and public directory.
  443. * The default is TRUE which indicates a private and protected directory.
  444. */
  445. function file_create_htaccess($directory, $private = TRUE) {
  446. if (file_uri_scheme($directory)) {
  447. $directory = file_stream_wrapper_uri_normalize($directory);
  448. }
  449. else {
  450. $directory = rtrim($directory, '/\\');
  451. }
  452. $htaccess_path = $directory . '/.htaccess';
  453. if (file_exists($htaccess_path)) {
  454. // Short circuit if the .htaccess file already exists.
  455. return;
  456. }
  457. if ($private) {
  458. // Private .htaccess file.
  459. $htaccess_lines = "SetHandler Drupal_Security_Do_Not_Remove_See_SA_2006_006\nDeny from all\nOptions None\nOptions +FollowSymLinks";
  460. }
  461. else {
  462. // Public .htaccess file.
  463. $htaccess_lines = "SetHandler Drupal_Security_Do_Not_Remove_See_SA_2006_006\nOptions None\nOptions +FollowSymLinks";
  464. }
  465. // Write the .htaccess file.
  466. if (file_put_contents($htaccess_path, $htaccess_lines)) {
  467. drupal_chmod($htaccess_path, 0444);
  468. }
  469. else {
  470. $variables = array('%directory' => $directory, '!htaccess' => '<br />' . nl2br(check_plain($htaccess_lines)));
  471. watchdog('security', "Security warning: Couldn't write .htaccess file. Please create a .htaccess file in your %directory directory which contains the following lines: <code>!htaccess</code>", $variables, WATCHDOG_ERROR);
  472. }
  473. }
  474. /**
  475. * Loads file objects from the database.
  476. *
  477. * @param $fids
  478. * An array of file IDs.
  479. * @param $conditions
  480. * (deprecated) An associative array of conditions on the {file_managed}
  481. * table, where the keys are the database fields and the values are the
  482. * values those fields must have. Instead, it is preferable to use
  483. * EntityFieldQuery to retrieve a list of entity IDs loadable by
  484. * this function.
  485. *
  486. * @return
  487. * An array of file objects, indexed by fid.
  488. *
  489. * @todo Remove $conditions in Drupal 8.
  490. *
  491. * @see hook_file_load()
  492. * @see file_load()
  493. * @see entity_load()
  494. * @see EntityFieldQuery
  495. */
  496. function file_load_multiple($fids = array(), $conditions = array()) {
  497. return entity_load('file', $fids, $conditions);
  498. }
  499. /**
  500. * Loads a single file object from the database.
  501. *
  502. * @param $fid
  503. * A file ID.
  504. *
  505. * @return
  506. * An object representing the file, or FALSE if the file was not found.
  507. *
  508. * @see hook_file_load()
  509. * @see file_load_multiple()
  510. */
  511. function file_load($fid) {
  512. $files = file_load_multiple(array($fid), array());
  513. return reset($files);
  514. }
  515. /**
  516. * Saves a file object to the database.
  517. *
  518. * If the $file->fid is not set a new record will be added.
  519. *
  520. * @param $file
  521. * A file object returned by file_load().
  522. *
  523. * @return
  524. * The updated file object.
  525. *
  526. * @see hook_file_insert()
  527. * @see hook_file_update()
  528. */
  529. function file_save(stdClass $file) {
  530. $file->timestamp = REQUEST_TIME;
  531. $file->filesize = filesize($file->uri);
  532. // Load the stored entity, if any.
  533. if (!empty($file->fid) && !isset($file->original)) {
  534. $file->original = entity_load_unchanged('file', $file->fid);
  535. }
  536. module_invoke_all('file_presave', $file);
  537. module_invoke_all('entity_presave', $file, 'file');
  538. if (empty($file->fid)) {
  539. drupal_write_record('file_managed', $file);
  540. // Inform modules about the newly added file.
  541. module_invoke_all('file_insert', $file);
  542. module_invoke_all('entity_insert', $file, 'file');
  543. }
  544. else {
  545. drupal_write_record('file_managed', $file, 'fid');
  546. // Inform modules that the file has been updated.
  547. module_invoke_all('file_update', $file);
  548. module_invoke_all('entity_update', $file, 'file');
  549. }
  550. unset($file->original);
  551. return $file;
  552. }
  553. /**
  554. * Determines where a file is used.
  555. *
  556. * @param $file
  557. * A file object.
  558. *
  559. * @return
  560. * A nested array with usage data. The first level is keyed by module name,
  561. * the second by object type and the third by the object id. The value
  562. * of the third level contains the usage count.
  563. *
  564. * @see file_usage_add()
  565. * @see file_usage_delete()
  566. */
  567. function file_usage_list(stdClass $file) {
  568. $result = db_select('file_usage', 'f')
  569. ->fields('f', array('module', 'type', 'id', 'count'))
  570. ->condition('fid', $file->fid)
  571. ->condition('count', 0, '>')
  572. ->execute();
  573. $references = array();
  574. foreach ($result as $usage) {
  575. $references[$usage->module][$usage->type][$usage->id] = $usage->count;
  576. }
  577. return $references;
  578. }
  579. /**
  580. * Records that a module is using a file.
  581. *
  582. * This usage information will be queried during file_delete() to ensure that
  583. * a file is not in use before it is physically removed from disk.
  584. *
  585. * Examples:
  586. * - A module that associates files with nodes, so $type would be
  587. * 'node' and $id would be the node's nid. Files for all revisions are stored
  588. * within a single nid.
  589. * - The User module associates an image with a user, so $type would be 'user'
  590. * and the $id would be the user's uid.
  591. *
  592. * @param $file
  593. * A file object.
  594. * @param $module
  595. * The name of the module using the file.
  596. * @param $type
  597. * The type of the object that contains the referenced file.
  598. * @param $id
  599. * The unique, numeric ID of the object containing the referenced file.
  600. * @param $count
  601. * (optional) The number of references to add to the object. Defaults to 1.
  602. *
  603. * @see file_usage_list()
  604. * @see file_usage_delete()
  605. */
  606. function file_usage_add(stdClass $file, $module, $type, $id, $count = 1) {
  607. db_merge('file_usage')
  608. ->key(array(
  609. 'fid' => $file->fid,
  610. 'module' => $module,
  611. 'type' => $type,
  612. 'id' => $id,
  613. ))
  614. ->fields(array('count' => $count))
  615. ->expression('count', 'count + :count', array(':count' => $count))
  616. ->execute();
  617. }
  618. /**
  619. * Removes a record to indicate that a module is no longer using a file.
  620. *
  621. * The file_delete() function is typically called after removing a file usage
  622. * to remove the record from the file_managed table and delete the file itself.
  623. *
  624. * @param $file
  625. * A file object.
  626. * @param $module
  627. * The name of the module using the file.
  628. * @param $type
  629. * (optional) The type of the object that contains the referenced file. May
  630. * be omitted if all module references to a file are being deleted.
  631. * @param $id
  632. * (optional) The unique, numeric ID of the object containing the referenced
  633. * file. May be omitted if all module references to a file are being deleted.
  634. * @param $count
  635. * (optional) The number of references to delete from the object. Defaults to
  636. * 1. 0 may be specified to delete all references to the file within a
  637. * specific object.
  638. *
  639. * @see file_usage_add()
  640. * @see file_usage_list()
  641. * @see file_delete()
  642. */
  643. function file_usage_delete(stdClass $file, $module, $type = NULL, $id = NULL, $count = 1) {
  644. // Delete rows that have a exact or less value to prevent empty rows.
  645. $query = db_delete('file_usage')
  646. ->condition('module', $module)
  647. ->condition('fid', $file->fid);
  648. if ($type && $id) {
  649. $query
  650. ->condition('type', $type)
  651. ->condition('id', $id);
  652. }
  653. if ($count) {
  654. $query->condition('count', $count, '<=');
  655. }
  656. $result = $query->execute();
  657. // If the row has more than the specified count decrement it by that number.
  658. if (!$result && $count > 0) {
  659. $query = db_update('file_usage')
  660. ->condition('module', $module)
  661. ->condition('fid', $file->fid);
  662. if ($type && $id) {
  663. $query
  664. ->condition('type', $type)
  665. ->condition('id', $id);
  666. }
  667. $query->expression('count', 'count - :count', array(':count' => $count));
  668. $query->execute();
  669. }
  670. }
  671. /**
  672. * Copies a file to a new location and adds a file record to the database.
  673. *
  674. * This function should be used when manipulating files that have records
  675. * stored in the database. This is a powerful function that in many ways
  676. * performs like an advanced version of copy().
  677. * - Checks if $source and $destination are valid and readable/writable.
  678. * - Checks that $source is not equal to $destination; if they are an error
  679. * is reported.
  680. * - If file already exists in $destination either the call will error out,
  681. * replace the file or rename the file based on the $replace parameter.
  682. * - Adds the new file to the files database. If the source file is a
  683. * temporary file, the resulting file will also be a temporary file. See
  684. * file_save_upload() for details on temporary files.
  685. *
  686. * @param $source
  687. * A file object.
  688. * @param $destination
  689. * A string containing the destination that $source should be copied to.
  690. * This must be a stream wrapper URI.
  691. * @param $replace
  692. * Replace behavior when the destination file already exists:
  693. * - FILE_EXISTS_REPLACE - Replace the existing file. If a managed file with
  694. * the destination name exists then its database entry will be updated. If
  695. * no database entry is found then a new one will be created.
  696. * - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
  697. * unique.
  698. * - FILE_EXISTS_ERROR - Do nothing and return FALSE.
  699. *
  700. * @return
  701. * File object if the copy is successful, or FALSE in the event of an error.
  702. *
  703. * @see file_unmanaged_copy()
  704. * @see hook_file_copy()
  705. */
  706. function file_copy(stdClass $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  707. if (!file_valid_uri($destination)) {
  708. if (($realpath = drupal_realpath($source->uri)) !== FALSE) {
  709. watchdog('file', 'File %file (%realpath) could not be copied, because the destination %destination is invalid. This is often caused by improper use of file_copy() or a missing stream wrapper.', array('%file' => $source->uri, '%realpath' => $realpath, '%destination' => $destination));
  710. }
  711. else {
  712. watchdog('file', 'File %file could not be copied, because the destination %destination is invalid. This is often caused by improper use of file_copy() or a missing stream wrapper.', array('%file' => $source->uri, '%destination' => $destination));
  713. }
  714. drupal_set_message(t('The specified file %file could not be copied, because the destination is invalid. More information is available in the system log.', array('%file' => $source->uri)), 'error');
  715. return FALSE;
  716. }
  717. if ($uri = file_unmanaged_copy($source->uri, $destination, $replace)) {
  718. $file = clone $source;
  719. $file->fid = NULL;
  720. $file->uri = $uri;
  721. $file->filename = drupal_basename($uri);
  722. // If we are replacing an existing file re-use its database record.
  723. if ($replace == FILE_EXISTS_REPLACE) {
  724. $existing_files = file_load_multiple(array(), array('uri' => $uri));
  725. if (count($existing_files)) {
  726. $existing = reset($existing_files);
  727. $file->fid = $existing->fid;
  728. $file->filename = $existing->filename;
  729. }
  730. }
  731. // If we are renaming around an existing file (rather than a directory),
  732. // use its basename for the filename.
  733. elseif ($replace == FILE_EXISTS_RENAME && is_file($destination)) {
  734. $file->filename = drupal_basename($destination);
  735. }
  736. $file = file_save($file);
  737. // Inform modules that the file has been copied.
  738. module_invoke_all('file_copy', $file, $source);
  739. return $file;
  740. }
  741. return FALSE;
  742. }
  743. /**
  744. * Determines whether the URI has a valid scheme for file API operations.
  745. *
  746. * There must be a scheme and it must be a Drupal-provided scheme like
  747. * 'public', 'private', 'temporary', or an extension provided with
  748. * hook_stream_wrappers().
  749. *
  750. * @param $uri
  751. * The URI to be tested.
  752. *
  753. * @return
  754. * TRUE if the URI is allowed.
  755. */
  756. function file_valid_uri($uri) {
  757. // Assert that the URI has an allowed scheme. Barepaths are not allowed.
  758. $uri_scheme = file_uri_scheme($uri);
  759. if (empty($uri_scheme) || !file_stream_wrapper_valid_scheme($uri_scheme)) {
  760. return FALSE;
  761. }
  762. return TRUE;
  763. }
  764. /**
  765. * Copies a file to a new location without invoking the file API.
  766. *
  767. * This is a powerful function that in many ways performs like an advanced
  768. * version of copy().
  769. * - Checks if $source and $destination are valid and readable/writable.
  770. * - Checks that $source is not equal to $destination; if they are an error
  771. * is reported.
  772. * - If file already exists in $destination either the call will error out,
  773. * replace the file or rename the file based on the $replace parameter.
  774. * - Provides a fallback using realpaths if the move fails using stream
  775. * wrappers. This can occur because PHP's copy() function does not properly
  776. * support streams if safe_mode or open_basedir are enabled. See
  777. * https://bugs.php.net/bug.php?id=60456
  778. *
  779. * @param $source
  780. * A string specifying the filepath or URI of the source file.
  781. * @param $destination
  782. * A URI containing the destination that $source should be copied to. The
  783. * URI may be a bare filepath (without a scheme) and in that case the default
  784. * scheme (file://) will be used. If this value is omitted, Drupal's default
  785. * files scheme will be used, usually "public://".
  786. * @param $replace
  787. * Replace behavior when the destination file already exists:
  788. * - FILE_EXISTS_REPLACE - Replace the existing file.
  789. * - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
  790. * unique.
  791. * - FILE_EXISTS_ERROR - Do nothing and return FALSE.
  792. *
  793. * @return
  794. * The path to the new file, or FALSE in the event of an error.
  795. *
  796. * @see file_copy()
  797. */
  798. function file_unmanaged_copy($source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  799. $original_source = $source;
  800. $original_destination = $destination;
  801. // Assert that the source file actually exists.
  802. if (!file_exists($source)) {
  803. // @todo Replace drupal_set_message() calls with exceptions instead.
  804. drupal_set_message(t('The specified file %file could not be copied, because no file by that name exists. Please check that you supplied the correct filename.', array('%file' => $original_source)), 'error');
  805. if (($realpath = drupal_realpath($original_source)) !== FALSE) {
  806. watchdog('file', 'File %file (%realpath) could not be copied because it does not exist.', array('%file' => $original_source, '%realpath' => $realpath));
  807. }
  808. else {
  809. watchdog('file', 'File %file could not be copied because it does not exist.', array('%file' => $original_source));
  810. }
  811. return FALSE;
  812. }
  813. // Build a destination URI if necessary.
  814. if (!isset($destination)) {
  815. $destination = file_build_uri(drupal_basename($source));
  816. }
  817. // Prepare the destination directory.
  818. if (file_prepare_directory($destination)) {
  819. // The destination is already a directory, so append the source basename.
  820. $destination = file_stream_wrapper_uri_normalize($destination . '/' . drupal_basename($source));
  821. }
  822. else {
  823. // Perhaps $destination is a dir/file?
  824. $dirname = drupal_dirname($destination);
  825. if (!file_prepare_directory($dirname)) {
  826. // The destination is not valid.
  827. watchdog('file', 'File %file could not be copied, because the destination directory %destination is not configured correctly.', array('%file' => $original_source, '%destination' => $dirname));
  828. drupal_set_message(t('The specified file %file could not be copied, because the destination directory is not properly configured. This may be caused by a problem with file or directory permissions. More information is available in the system log.', array('%file' => $original_source)), 'error');
  829. return FALSE;
  830. }
  831. }
  832. // Determine whether we can perform this operation based on overwrite rules.
  833. $destination = file_destination($destination, $replace);
  834. if ($destination === FALSE) {
  835. drupal_set_message(t('The file %file could not be copied because a file by that name already exists in the destination directory.', array('%file' => $original_source)), 'error');
  836. watchdog('file', 'File %file could not be copied because a file by that name already exists in the destination directory (%directory)', array('%file' => $original_source, '%destination' => $destination));
  837. return FALSE;
  838. }
  839. // Assert that the source and destination filenames are not the same.
  840. $real_source = drupal_realpath($source);
  841. $real_destination = drupal_realpath($destination);
  842. if ($source == $destination || ($real_source !== FALSE) && ($real_source == $real_destination)) {
  843. drupal_set_message(t('The specified file %file was not copied because it would overwrite itself.', array('%file' => $source)), 'error');
  844. watchdog('file', 'File %file could not be copied because it would overwrite itself.', array('%file' => $source));
  845. return FALSE;
  846. }
  847. // Make sure the .htaccess files are present.
  848. file_ensure_htaccess();
  849. // Perform the copy operation.
  850. if (!@copy($source, $destination)) {
  851. // If the copy failed and realpaths exist, retry the operation using them
  852. // instead.
  853. if ($real_source === FALSE || $real_destination === FALSE || !@copy($real_source, $real_destination)) {
  854. watchdog('file', 'The specified file %file could not be copied to %destination.', array('%file' => $source, '%destination' => $destination), WATCHDOG_ERROR);
  855. return FALSE;
  856. }
  857. }
  858. // Set the permissions on the new file.
  859. drupal_chmod($destination);
  860. return $destination;
  861. }
  862. /**
  863. * Constructs a URI to Drupal's default files location given a relative path.
  864. */
  865. function file_build_uri($path) {
  866. $uri = file_default_scheme() . '://' . $path;
  867. return file_stream_wrapper_uri_normalize($uri);
  868. }
  869. /**
  870. * Determines the destination path for a file.
  871. *
  872. * @param $destination
  873. * A string specifying the desired final URI or filepath.
  874. * @param $replace
  875. * Replace behavior when the destination file already exists.
  876. * - FILE_EXISTS_REPLACE - Replace the existing file.
  877. * - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
  878. * unique.
  879. * - FILE_EXISTS_ERROR - Do nothing and return FALSE.
  880. *
  881. * @return
  882. * The destination filepath, or FALSE if the file already exists
  883. * and FILE_EXISTS_ERROR is specified.
  884. */
  885. function file_destination($destination, $replace) {
  886. if (file_exists($destination)) {
  887. switch ($replace) {
  888. case FILE_EXISTS_REPLACE:
  889. // Do nothing here, we want to overwrite the existing file.
  890. break;
  891. case FILE_EXISTS_RENAME:
  892. $basename = drupal_basename($destination);
  893. $directory = drupal_dirname($destination);
  894. $destination = file_create_filename($basename, $directory);
  895. break;
  896. case FILE_EXISTS_ERROR:
  897. // Error reporting handled by calling function.
  898. return FALSE;
  899. }
  900. }
  901. return $destination;
  902. }
  903. /**
  904. * Moves a file to a new location and update the file's database entry.
  905. *
  906. * Moving a file is performed by copying the file to the new location and then
  907. * deleting the original.
  908. * - Checks if $source and $destination are valid and readable/writable.
  909. * - Performs a file move if $source is not equal to $destination.
  910. * - If file already exists in $destination either the call will error out,
  911. * replace the file or rename the file based on the $replace parameter.
  912. * - Adds the new file to the files database.
  913. *
  914. * @param $source
  915. * A file object.
  916. * @param $destination
  917. * A string containing the destination that $source should be moved to.
  918. * This must be a stream wrapper URI.
  919. * @param $replace
  920. * Replace behavior when the destination file already exists:
  921. * - FILE_EXISTS_REPLACE - Replace the existing file. If a managed file with
  922. * the destination name exists then its database entry will be updated and
  923. * file_delete() called on the source file after hook_file_move is called.
  924. * If no database entry is found then the source files record will be
  925. * updated.
  926. * - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
  927. * unique.
  928. * - FILE_EXISTS_ERROR - Do nothing and return FALSE.
  929. *
  930. * @return
  931. * Resulting file object for success, or FALSE in the event of an error.
  932. *
  933. * @see file_unmanaged_move()
  934. * @see hook_file_move()
  935. */
  936. function file_move(stdClass $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  937. if (!file_valid_uri($destination)) {
  938. if (($realpath = drupal_realpath($source->uri)) !== FALSE) {
  939. watchdog('file', 'File %file (%realpath) could not be moved, because the destination %destination is invalid. This may be caused by improper use of file_move() or a missing stream wrapper.', array('%file' => $source->uri, '%realpath' => $realpath, '%destination' => $destination));
  940. }
  941. else {
  942. watchdog('file', 'File %file could not be moved, because the destination %destination is invalid. This may be caused by improper use of file_move() or a missing stream wrapper.', array('%file' => $source->uri, '%destination' => $destination));
  943. }
  944. drupal_set_message(t('The specified file %file could not be moved, because the destination is invalid. More information is available in the system log.', array('%file' => $source->uri)), 'error');
  945. return FALSE;
  946. }
  947. if ($uri = file_unmanaged_move($source->uri, $destination, $replace)) {
  948. $delete_source = FALSE;
  949. $file = clone $source;
  950. $file->uri = $uri;
  951. // If we are replacing an existing file re-use its database record.
  952. if ($replace == FILE_EXISTS_REPLACE) {
  953. $existing_files = file_load_multiple(array(), array('uri' => $uri));
  954. if (count($existing_files)) {
  955. $existing = reset($existing_files);
  956. $delete_source = TRUE;
  957. $file->fid = $existing->fid;
  958. }
  959. }
  960. // If we are renaming around an existing file (rather than a directory),
  961. // use its basename for the filename.
  962. elseif ($replace == FILE_EXISTS_RENAME && is_file($destination)) {
  963. $file->filename = drupal_basename($destination);
  964. }
  965. $file = file_save($file);
  966. // Inform modules that the file has been moved.
  967. module_invoke_all('file_move', $file, $source);
  968. if ($delete_source) {
  969. // Try a soft delete to remove original if it's not in use elsewhere.
  970. file_delete($source);
  971. }
  972. return $file;
  973. }
  974. return FALSE;
  975. }
  976. /**
  977. * Moves a file to a new location without database changes or hook invocation.
  978. *
  979. * @param $source
  980. * A string specifying the filepath or URI of the original file.
  981. * @param $destination
  982. * A string containing the destination that $source should be moved to.
  983. * This must be a stream wrapper URI. If this value is omitted, Drupal's
  984. * default files scheme will be used, usually "public://".
  985. * @param $replace
  986. * Replace behavior when the destination file already exists:
  987. * - FILE_EXISTS_REPLACE - Replace the existing file.
  988. * - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
  989. * unique.
  990. * - FILE_EXISTS_ERROR - Do nothing and return FALSE.
  991. *
  992. * @return
  993. * The URI of the moved file, or FALSE in the event of an error.
  994. *
  995. * @see file_move()
  996. */
  997. function file_unmanaged_move($source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  998. $filepath = file_unmanaged_copy($source, $destination, $replace);
  999. if ($filepath == FALSE || file_unmanaged_delete($source) == FALSE) {
  1000. return FALSE;
  1001. }
  1002. return $filepath;
  1003. }
  1004. /**
  1005. * Modifies a filename as needed for security purposes.
  1006. *
  1007. * Munging a file name prevents unknown file extensions from masking exploit
  1008. * files. When web servers such as Apache decide how to process a URL request,
  1009. * they use the file extension. If the extension is not recognized, Apache
  1010. * skips that extension and uses the previous file extension. For example, if
  1011. * the file being requested is exploit.php.pps, and Apache does not recognize
  1012. * the '.pps' extension, it treats the file as PHP and executes it. To make
  1013. * this file name safe for Apache and prevent it from executing as PHP, the
  1014. * .php extension is "munged" into .php_, making the safe file name
  1015. * exploit.php_.pps.
  1016. *
  1017. * Specifically, this function adds an underscore to all extensions that are
  1018. * between 2 and 5 characters in length, internal to the file name, and not
  1019. * included in $extensions.
  1020. *
  1021. * Function behavior is also controlled by the Drupal variable
  1022. * 'allow_insecure_uploads'. If 'allow_insecure_uploads' evaluates to TRUE, no
  1023. * alterations will be made, if it evaluates to FALSE, the filename is 'munged'.
  1024. *
  1025. * @param $filename
  1026. * File name to modify.
  1027. * @param $extensions
  1028. * A space-separated list of extensions that should not be altered.
  1029. * @param $alerts
  1030. * If TRUE, drupal_set_message() will be called to display a message if the
  1031. * file name was changed.
  1032. *
  1033. * @return
  1034. * The potentially modified $filename.
  1035. */
  1036. function file_munge_filename($filename, $extensions, $alerts = TRUE) {
  1037. $original = $filename;
  1038. // Allow potentially insecure uploads for very savvy users and admin
  1039. if (!variable_get('allow_insecure_uploads', 0)) {
  1040. $whitelist = array_unique(explode(' ', trim($extensions)));
  1041. // Split the filename up by periods. The first part becomes the basename
  1042. // the last part the final extension.
  1043. $filename_parts = explode('.', $filename);
  1044. $new_filename = array_shift($filename_parts); // Remove file basename.
  1045. $final_extension = array_pop($filename_parts); // Remove final extension.
  1046. // Loop through the middle parts of the name and add an underscore to the
  1047. // end of each section that could be a file extension but isn't in the list
  1048. // of allowed extensions.
  1049. foreach ($filename_parts as $filename_part) {
  1050. $new_filename .= '.' . $filename_part;
  1051. if (!in_array($filename_part, $whitelist) && preg_match("/^[a-zA-Z]{2,5}\d?$/", $filename_part)) {
  1052. $new_filename .= '_';
  1053. }
  1054. }
  1055. $filename = $new_filename . '.' . $final_extension;
  1056. if ($alerts && $original != $filename) {
  1057. drupal_set_message(t('For security reasons, your upload has been renamed to %filename.', array('%filename' => $filename)));
  1058. }
  1059. }
  1060. return $filename;
  1061. }
  1062. /**
  1063. * Undoes the effect of file_munge_filename().
  1064. *
  1065. * @param $filename
  1066. * String with the filename to be unmunged.
  1067. *
  1068. * @return
  1069. * An unmunged filename string.
  1070. */
  1071. function file_unmunge_filename($filename) {
  1072. return str_replace('_.', '.', $filename);
  1073. }
  1074. /**
  1075. * Creates a full file path from a directory and filename.
  1076. *
  1077. * If a file with the specified name already exists, an alternative will be
  1078. * used.
  1079. *
  1080. * @param $basename
  1081. * String filename
  1082. * @param $directory
  1083. * String containing the directory or parent URI.
  1084. *
  1085. * @return
  1086. * File path consisting of $directory and a unique filename based off
  1087. * of $basename.
  1088. */
  1089. function file_create_filename($basename, $directory) {
  1090. // Strip control characters (ASCII value < 32). Though these are allowed in
  1091. // some filesystems, not many applications handle them well.
  1092. $basename = preg_replace('/[\x00-\x1F]/u', '_', $basename);
  1093. if (substr(PHP_OS, 0, 3) == 'WIN') {
  1094. // These characters are not allowed in Windows filenames
  1095. $basename = str_replace(array(':', '*', '?', '"', '<', '>', '|'), '_', $basename);
  1096. }
  1097. // A URI or path may already have a trailing slash or look like "public://".
  1098. if (substr($directory, -1) == '/') {
  1099. $separator = '';
  1100. }
  1101. else {
  1102. $separator = '/';
  1103. }
  1104. $destination = $directory . $separator . $basename;
  1105. if (file_exists($destination)) {
  1106. // Destination file already exists, generate an alternative.
  1107. $pos = strrpos($basename, '.');
  1108. if ($pos !== FALSE) {
  1109. $name = substr($basename, 0, $pos);
  1110. $ext = substr($basename, $pos);
  1111. }
  1112. else {
  1113. $name = $basename;
  1114. $ext = '';
  1115. }
  1116. $counter = 0;
  1117. do {
  1118. $destination = $directory . $separator . $name . '_' . $counter++ . $ext;
  1119. } while (file_exists($destination));
  1120. }
  1121. return $destination;
  1122. }
  1123. /**
  1124. * Deletes a file and its database record.
  1125. *
  1126. * If the $force parameter is not TRUE, file_usage_list() will be called to
  1127. * determine if the file is being used by any modules. If the file is being
  1128. * used the delete will be canceled.
  1129. *
  1130. * @param $file
  1131. * A file object.
  1132. * @param $force
  1133. * Boolean indicating that the file should be deleted even if the file is
  1134. * reported as in use by the file_usage table.
  1135. *
  1136. * @return mixed
  1137. * TRUE for success, FALSE in the event of an error, or an array if the file
  1138. * is being used by any modules.
  1139. *
  1140. * @see file_unmanaged_delete()
  1141. * @see file_usage_list()
  1142. * @see file_usage_delete()
  1143. * @see hook_file_delete()
  1144. */
  1145. function file_delete(stdClass $file, $force = FALSE) {
  1146. if (!file_valid_uri($file->uri)) {
  1147. if (($realpath = drupal_realpath($file->uri)) !== FALSE) {
  1148. watchdog('file', 'File %file (%realpath) could not be deleted because it is not a valid URI. This may be caused by improper use of file_delete() or a missing stream wrapper.', array('%file' => $file->uri, '%realpath' => $realpath));
  1149. }
  1150. else {
  1151. watchdog('file', 'File %file could not be deleted because it is not a valid URI. This may be caused by improper use of file_delete() or a missing stream wrapper.', array('%file' => $file->uri));
  1152. }
  1153. drupal_set_message(t('The specified file %file could not be deleted, because it is not a valid URI. More information is available in the system log.', array('%file' => $file->uri)), 'error');
  1154. return FALSE;
  1155. }
  1156. // If any module still has a usage entry in the file_usage table, the file
  1157. // will not be deleted, but file_delete() will return a populated array
  1158. // that tests as TRUE.
  1159. if (!$force && ($references = file_usage_list($file))) {
  1160. return $references;
  1161. }
  1162. // Let other modules clean up any references to the deleted file.
  1163. module_invoke_all('file_delete', $file);
  1164. module_invoke_all('entity_delete', $file, 'file');
  1165. // Make sure the file is deleted before removing its row from the
  1166. // database, so UIs can still find the file in the database.
  1167. if (file_unmanaged_delete($file->uri)) {
  1168. db_delete('file_managed')->condition('fid', $file->fid)->execute();
  1169. db_delete('file_usage')->condition('fid', $file->fid)->execute();
  1170. return TRUE;
  1171. }
  1172. return FALSE;
  1173. }
  1174. /**
  1175. * Deletes a file without database changes or hook invocations.
  1176. *
  1177. * This function should be used when the file to be deleted does not have an
  1178. * entry recorded in the files table.
  1179. *
  1180. * @param $path
  1181. * A string containing a file path or (streamwrapper) URI.
  1182. *
  1183. * @return
  1184. * TRUE for success or path does not exist, or FALSE in the event of an
  1185. * error.
  1186. *
  1187. * @see file_delete()
  1188. * @see file_unmanaged_delete_recursive()
  1189. */
  1190. function file_unmanaged_delete($path) {
  1191. if (is_dir($path)) {
  1192. watchdog('file', '%path is a directory and cannot be removed using file_unmanaged_delete().', array('%path' => $path), WATCHDOG_ERROR);
  1193. return FALSE;
  1194. }
  1195. if (is_file($path)) {
  1196. return drupal_unlink($path);
  1197. }
  1198. // Return TRUE for non-existent file, but log that nothing was actually
  1199. // deleted, as the current state is the intended result.
  1200. if (!file_exists($path)) {
  1201. watchdog('file', 'The file %path was not deleted, because it does not exist.', array('%path' => $path), WATCHDOG_NOTICE);
  1202. return TRUE;
  1203. }
  1204. // We cannot handle anything other than files and directories. Log an error
  1205. // for everything else (sockets, symbolic links, etc).
  1206. watchdog('file', 'The file %path is not of a recognized type so it was not deleted.', array('%path' => $path), WATCHDOG_ERROR);
  1207. return FALSE;
  1208. }
  1209. /**
  1210. * Deletes all files and directories in the specified filepath recursively.
  1211. *
  1212. * If the specified path is a directory then the function will call itself
  1213. * recursively to process the contents. Once the contents have been removed the
  1214. * directory will also be removed.
  1215. *
  1216. * If the specified path is a file then it will be passed to
  1217. * file_unmanaged_delete().
  1218. *
  1219. * Note that this only deletes visible files with write permission.
  1220. *
  1221. * @param $path
  1222. * A string containing either an URI or a file or directory path.
  1223. *
  1224. * @return
  1225. * TRUE for success or if path does not exist, FALSE in the event of an
  1226. * error.
  1227. *
  1228. * @see file_unmanaged_delete()
  1229. */
  1230. function file_unmanaged_delete_recursive($path) {
  1231. if (is_dir($path)) {
  1232. $dir = dir($path);
  1233. while (($entry = $dir->read()) !== FALSE) {
  1234. if ($entry == '.' || $entry == '..') {
  1235. continue;
  1236. }
  1237. $entry_path = $path . '/' . $entry;
  1238. file_unmanaged_delete_recursive($entry_path);
  1239. }
  1240. $dir->close();
  1241. return drupal_rmdir($path);
  1242. }
  1243. return file_unmanaged_delete($path);
  1244. }
  1245. /**
  1246. * Determines total disk space used by a single user or the whole filesystem.
  1247. *
  1248. * @param $uid
  1249. * Optional. A user id, specifying NULL returns the total space used by all
  1250. * non-temporary files.
  1251. * @param $status
  1252. * Optional. The file status to consider. The default is to only
  1253. * consider files in status FILE_STATUS_PERMANENT.
  1254. *
  1255. * @return
  1256. * An integer containing the number of bytes used.
  1257. */
  1258. function file_space_used($uid = NULL, $status = FILE_STATUS_PERMANENT) {
  1259. $query = db_select('file_managed', 'f');
  1260. $query->condition('f.status', $status);
  1261. $query->addExpression('SUM(f.filesize)', 'filesize');
  1262. if (isset($uid)) {
  1263. $query->condition('f.uid', $uid);
  1264. }
  1265. return $query->execute()->fetchField();
  1266. }
  1267. /**
  1268. * Saves a file upload to a new location.
  1269. *
  1270. * The file will be added to the {file_managed} table as a temporary file.
  1271. * Temporary files are periodically cleaned. To make the file a permanent file,
  1272. * assign the status and use file_save() to save the changes.
  1273. *
  1274. * @param $source
  1275. * A string specifying the filepath or URI of the uploaded file to save.
  1276. * @param $validators
  1277. * An optional, associative array of callback functions used to validate the
  1278. * file. See file_validate() for a full discussion of the array format.
  1279. * If no extension validator is provided it will default to a limited safe
  1280. * list of extensions which is as follows: "jpg jpeg gif png txt
  1281. * doc xls pdf ppt pps odt ods odp". To allow all extensions you must
  1282. * explicitly set the 'file_validate_extensions' validator to an empty array
  1283. * (Beware: this is not safe and should only be allowed for trusted users, if
  1284. * at all).
  1285. * @param $destination
  1286. * A string containing the URI $source should be copied to.
  1287. * This must be a stream wrapper URI. If this value is omitted, Drupal's
  1288. * temporary files scheme will be used ("temporary://").
  1289. * @param $replace
  1290. * Replace behavior when the destination file already exists:
  1291. * - FILE_EXISTS_REPLACE: Replace the existing file.
  1292. * - FILE_EXISTS_RENAME: Append _{incrementing number} until the filename is
  1293. * unique.
  1294. * - FILE_EXISTS_ERROR: Do nothing and return FALSE.
  1295. *
  1296. * @return
  1297. * An object containing the file information if the upload succeeded, FALSE
  1298. * in the event of an error, or NULL if no file was uploaded. The
  1299. * documentation for the "File interface" group, which you can find under
  1300. * Related topics, or the header at the top of this file, documents the
  1301. * components of a file object. In addition to the standard components,
  1302. * this function adds:
  1303. * - source: Path to the file before it is moved.
  1304. * - destination: Path to the file after it is moved (same as 'uri').
  1305. */
  1306. function file_save_upload($source, $validators = array(), $destination = FALSE, $replace = FILE_EXISTS_RENAME) {
  1307. global $user;
  1308. static $upload_cache;
  1309. // Return cached objects without processing since the file will have
  1310. // already been processed and the paths in _FILES will be invalid.
  1311. if (isset($upload_cache[$source])) {
  1312. return $upload_cache[$source];
  1313. }
  1314. // Make sure there's an upload to process.
  1315. if (empty($_FILES['files']['name'][$source])) {
  1316. return NULL;
  1317. }
  1318. // Check for file upload errors and return FALSE if a lower level system
  1319. // error occurred. For a complete list of errors:
  1320. // See http://php.net/manual/en/features.file-upload.errors.php.
  1321. switch ($_FILES['files']['error'][$source]) {
  1322. case UPLOAD_ERR_INI_SIZE:
  1323. case UPLOAD_ERR_FORM_SIZE:
  1324. drupal_set_message(t('The file %file could not be saved, because it exceeds %maxsize, the maximum allowed size for uploads.', array('%file' => $_FILES['files']['name'][$source], '%maxsize' => format_size(file_upload_max_size()))), 'error');
  1325. return FALSE;
  1326. case UPLOAD_ERR_PARTIAL:
  1327. case UPLOAD_ERR_NO_FILE:
  1328. drupal_set_message(t('The file %file could not be saved, because the upload did not complete.', array('%file' => $_FILES['files']['name'][$source])), 'error');
  1329. return FALSE;
  1330. case UPLOAD_ERR_OK:
  1331. // Final check that this is a valid upload, if it isn't, use the
  1332. // default error handler.
  1333. if (is_uploaded_file($_FILES['files']['tmp_name'][$source])) {
  1334. break;
  1335. }
  1336. // Unknown error
  1337. default:
  1338. drupal_set_message(t('The file %file could not be saved. An unknown error has occurred.', array('%file' => $_FILES['files']['name'][$source])), 'error');
  1339. return FALSE;
  1340. }
  1341. // Begin building file object.
  1342. $file = new stdClass();
  1343. $file->uid = $user->uid;
  1344. $file->status = 0;
  1345. $file->filename = trim(drupal_basename($_FILES['files']['name'][$source]), '.');
  1346. $file->uri = $_FILES['files']['tmp_name'][$source];
  1347. $file->filemime = file_get_mimetype($file->filename);
  1348. $file->filesize = $_FILES['files']['size'][$source];
  1349. $extensions = '';
  1350. if (isset($validators['file_validate_extensions'])) {
  1351. if (isset($validators['file_validate_extensions'][0])) {
  1352. // Build the list of non-munged extensions if the caller provided them.
  1353. $extensions = $validators['file_validate_extensions'][0];
  1354. }
  1355. else {
  1356. // If 'file_validate_extensions' is set and the list is empty then the
  1357. // caller wants to allow any extension. In this case we have to remove the
  1358. // validator or else it will reject all extensions.
  1359. unset($validators['file_validate_extensions']);
  1360. }
  1361. }
  1362. else {
  1363. // No validator was provided, so add one using the default list.
  1364. // Build a default non-munged safe list for file_munge_filename().
  1365. $extensions = 'jpg jpeg gif png txt doc xls pdf ppt pps odt ods odp';
  1366. $validators['file_validate_extensions'] = array();
  1367. $validators['file_validate_extensions'][0] = $extensions;
  1368. }
  1369. if (!empty($extensions)) {
  1370. // Munge the filename to protect against possible malicious extension hiding
  1371. // within an unknown file type (ie: filename.html.foo).
  1372. $file->filename = file_munge_filename($file->filename, $extensions);
  1373. }
  1374. // Rename potentially executable files, to help prevent exploits (i.e. will
  1375. // rename filename.php.foo and filename.php to filename.php.foo.txt and
  1376. // filename.php.txt, respectively). Don't rename if 'allow_insecure_uploads'
  1377. // evaluates to TRUE.
  1378. if (!variable_get('allow_insecure_uploads', 0) && preg_match('/\.(php|pl|py|cgi|asp|js)(\.|$)/i', $file->filename) && (substr($file->filename, -4) != '.txt')) {
  1379. $file->filemime = 'text/plain';
  1380. $file->uri .= '.txt';
  1381. $file->filename .= '.txt';
  1382. // The .txt extension may not be in the allowed list of extensions. We have
  1383. // to add it here or else the file upload will fail.
  1384. if (!empty($extensions)) {
  1385. $validators['file_validate_extensions'][0] .= ' txt';
  1386. drupal_set_message(t('For security reasons, your upload has been renamed to %filename.', array('%filename' => $file->filename)));
  1387. }
  1388. }
  1389. // If the destination is not provided, use the temporary directory.
  1390. if (empty($destination)) {
  1391. $destination = 'temporary://';
  1392. }
  1393. // Assert that the destination contains a valid stream.
  1394. $destination_scheme = file_uri_scheme($destination);
  1395. if (!$destination_scheme || !file_stream_wrapper_valid_scheme($destination_scheme)) {
  1396. drupal_set_message(t('The file could not be uploaded, because the destination %destination is invalid.', array('%destination' => $destination)), 'error');
  1397. return FALSE;
  1398. }
  1399. $file->source = $source;
  1400. // A URI may already have a trailing slash or look like "public://".
  1401. if (substr($destination, -1) != '/') {
  1402. $destination .= '/';
  1403. }
  1404. $file->destination = file_destination($destination . $file->filename, $replace);
  1405. // If file_destination() returns FALSE then $replace == FILE_EXISTS_ERROR and
  1406. // there's an existing file so we need to bail.
  1407. if ($file->destination === FALSE) {
  1408. drupal_set_message(t('The file %source could not be uploaded because a file by that name already exists in the destination %directory.', array('%source' => $source, '%directory' => $destination)), 'error');
  1409. return FALSE;
  1410. }
  1411. // Add in our check of the the file name length.
  1412. $validators['file_validate_name_length'] = array();
  1413. // Call the validation functions specified by this function's caller.
  1414. $errors = file_validate($file, $validators);
  1415. // Check for errors.
  1416. if (!empty($errors)) {
  1417. $message = t('The specified file %name could not be uploaded.', array('%name' => $file->filename));
  1418. if (count($errors) > 1) {
  1419. $message .= theme('item_list', array('items' => $errors));
  1420. }
  1421. else {
  1422. $message .= ' ' . array_pop($errors);
  1423. }
  1424. form_set_error($source, $message);
  1425. return FALSE;
  1426. }
  1427. // Move uploaded files from PHP's upload_tmp_dir to Drupal's temporary
  1428. // directory. This overcomes open_basedir restrictions for future file
  1429. // operations.
  1430. $file->uri = $file->destination;
  1431. if (!drupal_move_uploaded_file($_FILES['files']['tmp_name'][$source], $file->uri)) {
  1432. form_set_error($source, t('File upload error. Could not move uploaded file.'));
  1433. watchdog('file', 'Upload error. Could not move uploaded file %file to destination %destination.', array('%file' => $file->filename, '%destination' => $file->uri));
  1434. return FALSE;
  1435. }
  1436. // Set the permissions on the new file.
  1437. drupal_chmod($file->uri);
  1438. // If we are replacing an existing file re-use its database record.
  1439. if ($replace == FILE_EXISTS_REPLACE) {
  1440. $existing_files = file_load_multiple(array(), array('uri' => $file->uri));
  1441. if (count($existing_files)) {
  1442. $existing = reset($existing_files);
  1443. $file->fid = $existing->fid;
  1444. }
  1445. }
  1446. // If we made it this far it's safe to record this file in the database.
  1447. if ($file = file_save($file)) {
  1448. // Add file to the cache.
  1449. $upload_cache[$source] = $file;
  1450. return $file;
  1451. }
  1452. return FALSE;
  1453. }
  1454. /**
  1455. * Moves an uploaded file to a new location.
  1456. *
  1457. * PHP's move_uploaded_file() does not properly support streams if safe_mode
  1458. * or open_basedir are enabled, so this function fills that gap.
  1459. *
  1460. * Compatibility: normal paths and stream wrappers.
  1461. *
  1462. * @param $filename
  1463. * The filename of the uploaded file.
  1464. * @param $uri
  1465. * A string containing the destination URI of the file.
  1466. *
  1467. * @return
  1468. * TRUE on success, or FALSE on failure.
  1469. *
  1470. * @see move_uploaded_file()
  1471. * @see http://drupal.org/node/515192
  1472. * @ingroup php_wrappers
  1473. */
  1474. function drupal_move_uploaded_file($filename, $uri) {
  1475. $result = @move_uploaded_file($filename, $uri);
  1476. // PHP's move_uploaded_file() does not properly support streams if safe_mode
  1477. // or open_basedir are enabled so if the move failed, try finding a real path
  1478. // and retry the move operation.
  1479. if (!$result) {
  1480. if ($realpath = drupal_realpath($uri)) {
  1481. $result = move_uploaded_file($filename, $realpath);
  1482. }
  1483. else {
  1484. $result = move_uploaded_file($filename, $uri);
  1485. }
  1486. }
  1487. return $result;
  1488. }
  1489. /**
  1490. * Checks that a file meets the criteria specified by the validators.
  1491. *
  1492. * After executing the validator callbacks specified hook_file_validate() will
  1493. * also be called to allow other modules to report errors about the file.
  1494. *
  1495. * @param $file
  1496. * A Drupal file object.
  1497. * @param $validators
  1498. * An optional, associative array of callback functions used to validate the
  1499. * file. The keys are function names and the values arrays of callback
  1500. * parameters which will be passed in after the file object. The
  1501. * functions should return an array of error messages; an empty array
  1502. * indicates that the file passed validation. The functions will be called in
  1503. * the order specified.
  1504. *
  1505. * @return
  1506. * An array containing validation error messages.
  1507. *
  1508. * @see hook_file_validate()
  1509. */
  1510. function file_validate(stdClass &$file, $validators = array()) {
  1511. // Call the validation functions specified by this function's caller.
  1512. $errors = array();
  1513. foreach ($validators as $function => $args) {
  1514. if (function_exists($function)) {
  1515. array_unshift($args, $file);
  1516. $errors = array_merge($errors, call_user_func_array($function, $args));
  1517. }
  1518. }
  1519. // Let other modules perform validation on the new file.
  1520. return array_merge($errors, module_invoke_all('file_validate', $file));
  1521. }
  1522. /**
  1523. * Checks for files with names longer than we can store in the database.
  1524. *
  1525. * @param $file
  1526. * A Drupal file object.
  1527. *
  1528. * @return
  1529. * An array. If the file name is too long, it will contain an error message.
  1530. */
  1531. function file_validate_name_length(stdClass $file) {
  1532. $errors = array();
  1533. if (empty($file->filename)) {
  1534. $errors[] = t("The file's name is empty. Please give a name to the file.");
  1535. }
  1536. if (strlen($file->filename) > 240) {
  1537. $errors[] = t("The file's name exceeds the 240 characters limit. Please rename the file and try again.");
  1538. }
  1539. return $errors;
  1540. }
  1541. /**
  1542. * Checks that the filename ends with an allowed extension.
  1543. *
  1544. * @param $file
  1545. * A Drupal file object.
  1546. * @param $extensions
  1547. * A string with a space separated list of allowed extensions.
  1548. *
  1549. * @return
  1550. * An array. If the file extension is not allowed, it will contain an error
  1551. * message.
  1552. *
  1553. * @see hook_file_validate()
  1554. */
  1555. function file_validate_extensions(stdClass $file, $extensions) {
  1556. $errors = array();
  1557. $regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
  1558. if (!preg_match($regex, $file->filename)) {
  1559. $errors[] = t('Only files with the following extensions are allowed: %files-allowed.', array('%files-allowed' => $extensions));
  1560. }
  1561. return $errors;
  1562. }
  1563. /**
  1564. * Checks that the file's size is below certain limits.
  1565. *
  1566. * This check is not enforced for the user #1.
  1567. *
  1568. * @param $file
  1569. * A Drupal file object.
  1570. * @param $file_limit
  1571. * An integer specifying the maximum file size in bytes. Zero indicates that
  1572. * no limit should be enforced.
  1573. * @param $user_limit
  1574. * An integer specifying the maximum number of bytes the user is allowed.
  1575. * Zero indicates that no limit should be enforced.
  1576. *
  1577. * @return
  1578. * An array. If the file size exceeds limits, it will contain an error
  1579. * message.
  1580. *
  1581. * @see hook_file_validate()
  1582. */
  1583. function file_validate_size(stdClass $file, $file_limit = 0, $user_limit = 0) {
  1584. global $user;
  1585. $errors = array();
  1586. // Bypass validation for uid = 1.
  1587. if ($user->uid != 1) {
  1588. if ($file_limit && $file->filesize > $file_limit) {
  1589. $errors[] = t('The file is %filesize exceeding the maximum file size of %maxsize.', array('%filesize' => format_size($file->filesize), '%maxsize' => format_size($file_limit)));
  1590. }
  1591. // Save a query by only calling file_space_used() when a limit is provided.
  1592. if ($user_limit && (file_space_used($user->uid) + $file->filesize) > $user_limit) {
  1593. $errors[] = t('The file is %filesize which would exceed your disk quota of %quota.', array('%filesize' => format_size($file->filesize), '%quota' => format_size($user_limit)));
  1594. }
  1595. }
  1596. return $errors;
  1597. }
  1598. /**
  1599. * Checks that the file is recognized by image_get_info() as an image.
  1600. *
  1601. * @param $file
  1602. * A Drupal file object.
  1603. *
  1604. * @return
  1605. * An array. If the file is not an image, it will contain an error message.
  1606. *
  1607. * @see hook_file_validate()
  1608. */
  1609. function file_validate_is_image(stdClass $file) {
  1610. $errors = array();
  1611. $info = image_get_info($file->uri);
  1612. if (!$info || empty($info['extension'])) {
  1613. $errors[] = t('Only JPEG, PNG and GIF images are allowed.');
  1614. }
  1615. return $errors;
  1616. }
  1617. /**
  1618. * Verifies that image dimensions are within the specified maximum and minimum.
  1619. *
  1620. * Non-image files will be ignored. If a image toolkit is available the image
  1621. * will be scaled to fit within the desired maximum dimensions.
  1622. *
  1623. * @param $file
  1624. * A Drupal file object. This function may resize the file affecting its
  1625. * size.
  1626. * @param $maximum_dimensions
  1627. * An optional string in the form WIDTHxHEIGHT e.g. '640x480' or '85x85'. If
  1628. * an image toolkit is installed the image will be resized down to these
  1629. * dimensions. A value of 0 indicates no restriction on size, so resizing
  1630. * will be attempted.
  1631. * @param $minimum_dimensions
  1632. * An optional string in the form WIDTHxHEIGHT. This will check that the
  1633. * image meets a minimum size. A value of 0 indicates no restriction.
  1634. *
  1635. * @return
  1636. * An array. If the file is an image and did not meet the requirements, it
  1637. * will contain an error message.
  1638. *
  1639. * @see hook_file_validate()
  1640. */
  1641. function file_validate_image_resolution(stdClass $file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
  1642. $errors = array();
  1643. // Check first that the file is an image.
  1644. if ($info = image_get_info($file->uri)) {
  1645. if ($maximum_dimensions) {
  1646. // Check that it is smaller than the given dimensions.
  1647. list($width, $height) = explode('x', $maximum_dimensions);
  1648. if ($info['width'] > $width || $info['height'] > $height) {
  1649. // Try to resize the image to fit the dimensions.
  1650. if ($image = image_load($file->uri)) {
  1651. image_scale($image, $width, $height);
  1652. image_save($image);
  1653. $file->filesize = $image->info['file_size'];
  1654. drupal_set_message(t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels.', array('%dimensions' => $maximum_dimensions)));
  1655. }
  1656. else {
  1657. $errors[] = t('The image is too large; the maximum dimensions are %dimensions pixels.', array('%dimensions' => $maximum_dimensions));
  1658. }
  1659. }
  1660. }
  1661. if ($minimum_dimensions) {
  1662. // Check that it is larger than the given dimensions.
  1663. list($width, $height) = explode('x', $minimum_dimensions);
  1664. if ($info['width'] < $width || $info['height'] < $height) {
  1665. $errors[] = t('The image is too small; the minimum dimensions are %dimensions pixels.', array('%dimensions' => $minimum_dimensions));
  1666. }
  1667. }
  1668. }
  1669. return $errors;
  1670. }
  1671. /**
  1672. * Saves a file to the specified destination and creates a database entry.
  1673. *
  1674. * @param $data
  1675. * A string containing the contents of the file.
  1676. * @param $destination
  1677. * A string containing the destination URI. This must be a stream wrapper URI.
  1678. * If no value is provided, a randomized name will be generated and the file
  1679. * will be saved using Drupal's default files scheme, usually "public://".
  1680. * @param $replace
  1681. * Replace behavior when the destination file already exists:
  1682. * - FILE_EXISTS_REPLACE - Replace the existing file. If a managed file with
  1683. * the destination name exists then its database entry will be updated. If
  1684. * no database entry is found then a new one will be created.
  1685. * - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
  1686. * unique.
  1687. * - FILE_EXISTS_ERROR - Do nothing and return FALSE.
  1688. *
  1689. * @return
  1690. * A file object, or FALSE on error.
  1691. *
  1692. * @see file_unmanaged_save_data()
  1693. */
  1694. function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  1695. global $user;
  1696. if (empty($destination)) {
  1697. $destination = file_default_scheme() . '://';
  1698. }
  1699. if (!file_valid_uri($destination)) {
  1700. watchdog('file', 'The data could not be saved because the destination %destination is invalid. This may be caused by improper use of file_save_data() or a missing stream wrapper.', array('%destination' => $destination));
  1701. drupal_set_message(t('The data could not be saved, because the destination is invalid. More information is available in the system log.'), 'error');
  1702. return FALSE;
  1703. }
  1704. if ($uri = file_unmanaged_save_data($data, $destination, $replace)) {
  1705. // Create a file object.
  1706. $file = new stdClass();
  1707. $file->fid = NULL;
  1708. $file->uri = $uri;
  1709. $file->filename = drupal_basename($uri);
  1710. $file->filemime = file_get_mimetype($file->uri);
  1711. $file->uid = $user->uid;
  1712. $file->status = FILE_STATUS_PERMANENT;
  1713. // If we are replacing an existing file re-use its database record.
  1714. if ($replace == FILE_EXISTS_REPLACE) {
  1715. $existing_files = file_load_multiple(array(), array('uri' => $uri));
  1716. if (count($existing_files)) {
  1717. $existing = reset($existing_files);
  1718. $file->fid = $existing->fid;
  1719. $file->filename = $existing->filename;
  1720. }
  1721. }
  1722. // If we are renaming around an existing file (rather than a directory),
  1723. // use its basename for the filename.
  1724. elseif ($replace == FILE_EXISTS_RENAME && is_file($destination)) {
  1725. $file->filename = drupal_basename($destination);
  1726. }
  1727. return file_save($file);
  1728. }
  1729. return FALSE;
  1730. }
  1731. /**
  1732. * Saves a string to the specified destination without invoking file API.
  1733. *
  1734. * This function is identical to file_save_data() except the file will not be
  1735. * saved to the {file_managed} table and none of the file_* hooks will be
  1736. * called.
  1737. *
  1738. * @param $data
  1739. * A string containing the contents of the file.
  1740. * @param $destination
  1741. * A string containing the destination location. This must be a stream wrapper
  1742. * URI. If no value is provided, a randomized name will be generated and the
  1743. * file will be saved using Drupal's default files scheme, usually
  1744. * "public://".
  1745. * @param $replace
  1746. * Replace behavior when the destination file already exists:
  1747. * - FILE_EXISTS_REPLACE - Replace the existing file.
  1748. * - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
  1749. * unique.
  1750. * - FILE_EXISTS_ERROR - Do nothing and return FALSE.
  1751. *
  1752. * @return
  1753. * A string with the path of the resulting file, or FALSE on error.
  1754. *
  1755. * @see file_save_data()
  1756. */
  1757. function file_unmanaged_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  1758. // Write the data to a temporary file.
  1759. $temp_name = drupal_tempnam('temporary://', 'file');
  1760. if (file_put_contents($temp_name, $data) === FALSE) {
  1761. drupal_set_message(t('The file could not be created.'), 'error');
  1762. return FALSE;
  1763. }
  1764. // Move the file to its final destination.
  1765. return file_unmanaged_move($temp_name, $destination, $replace);
  1766. }
  1767. /**
  1768. * Transfers a file to the client using HTTP.
  1769. *
  1770. * Pipes a file through Drupal to the client.
  1771. *
  1772. * @param $uri
  1773. * String specifying the file URI to transfer.
  1774. * @param $headers
  1775. * An array of HTTP headers to send along with file.
  1776. */
  1777. function file_transfer($uri, $headers) {
  1778. if (ob_get_level()) {
  1779. ob_end_clean();
  1780. }
  1781. foreach ($headers as $name => $value) {
  1782. drupal_add_http_header($name, $value);
  1783. }
  1784. drupal_send_headers();
  1785. $scheme = file_uri_scheme($uri);
  1786. // Transfer file in 1024 byte chunks to save memory usage.
  1787. if ($scheme && file_stream_wrapper_valid_scheme($scheme) && $fd = fopen($uri, 'rb')) {
  1788. while (!feof($fd)) {
  1789. print fread($fd, 1024);
  1790. }
  1791. fclose($fd);
  1792. }
  1793. else {
  1794. drupal_not_found();
  1795. }
  1796. drupal_exit();
  1797. }
  1798. /**
  1799. * Menu handler for private file transfers.
  1800. *
  1801. * Call modules that implement hook_file_download() to find out if a file is
  1802. * accessible and what headers it should be transferred with. If one or more
  1803. * modules returned headers the download will start with the returned headers.
  1804. * If a module returns -1 drupal_access_denied() will be returned. If the file
  1805. * exists but no modules responded drupal_access_denied() will be returned.
  1806. * If the file does not exist drupal_not_found() will be returned.
  1807. *
  1808. * @see system_menu()
  1809. */
  1810. function file_download() {
  1811. // Merge remainder of arguments from GET['q'], into relative file path.
  1812. $args = func_get_args();
  1813. $scheme = array_shift($args);
  1814. $target = implode('/', $args);
  1815. $uri = $scheme . '://' . $target;
  1816. if (file_stream_wrapper_valid_scheme($scheme) && file_exists($uri)) {
  1817. // Let other modules provide headers and controls access to the file.
  1818. // module_invoke_all() uses array_merge_recursive() which merges header
  1819. // values into a new array. To avoid that and allow modules to override
  1820. // headers instead, use array_merge() to merge the returned arrays.
  1821. $headers = array();
  1822. foreach (module_implements('file_download') as $module) {
  1823. $function = $module . '_file_download';
  1824. $result = $function($uri);
  1825. if ($result == -1) {
  1826. // Throw away the headers received so far.
  1827. $headers = array();
  1828. break;
  1829. }
  1830. if (isset($result) && is_array($result)) {
  1831. $headers = array_merge($headers, $result);
  1832. }
  1833. }
  1834. if (count($headers)) {
  1835. file_transfer($uri, $headers);
  1836. }
  1837. drupal_access_denied();
  1838. }
  1839. else {
  1840. drupal_not_found();
  1841. }
  1842. drupal_exit();
  1843. }
  1844. /**
  1845. * Finds all files that match a given mask in a given directory.
  1846. *
  1847. * Directories and files beginning with a period are excluded; this
  1848. * prevents hidden files and directories (such as SVN working directories)
  1849. * from being scanned.
  1850. *
  1851. * @param $dir
  1852. * The base directory or URI to scan, without trailing slash.
  1853. * @param $mask
  1854. * The preg_match() regular expression of the files to find.
  1855. * @param $options
  1856. * An associative array of additional options, with the following elements:
  1857. * - 'nomask': The preg_match() regular expression of the files to ignore.
  1858. * Defaults to '/(\.\.?|CVS)$/'.
  1859. * - 'callback': The callback function to call for each match. There is no
  1860. * default callback.
  1861. * - 'recurse': When TRUE, the directory scan will recurse the entire tree
  1862. * starting at the provided directory. Defaults to TRUE.
  1863. * - 'key': The key to be used for the returned associative array of files.
  1864. * Possible values are 'uri', for the file's URI; 'filename', for the
  1865. * basename of the file; and 'name' for the name of the file without the
  1866. * extension. Defaults to 'uri'.
  1867. * - 'min_depth': Minimum depth of directories to return files from. Defaults
  1868. * to 0.
  1869. * @param $depth
  1870. * Current depth of recursion. This parameter is only used internally and
  1871. * should not be passed in.
  1872. *
  1873. * @return
  1874. * An associative array (keyed on the chosen key) of objects with 'uri',
  1875. * 'filename', and 'name' members corresponding to the matching files.
  1876. */
  1877. function file_scan_directory($dir, $mask, $options = array(), $depth = 0) {
  1878. // Merge in defaults.
  1879. $options += array(
  1880. 'nomask' => '/(\.\.?|CVS)$/',
  1881. 'callback' => 0,
  1882. 'recurse' => TRUE,
  1883. 'key' => 'uri',
  1884. 'min_depth' => 0,
  1885. );
  1886. $options['key'] = in_array($options['key'], array('uri', 'filename', 'name')) ? $options['key'] : 'uri';
  1887. $files = array();
  1888. if (is_dir($dir) && $handle = opendir($dir)) {
  1889. while (FALSE !== ($filename = readdir($handle))) {
  1890. if (!preg_match($options['nomask'], $filename) && $filename[0] != '.') {
  1891. $uri = "$dir/$filename";
  1892. $uri = file_stream_wrapper_uri_normalize($uri);
  1893. if (is_dir($uri) && $options['recurse']) {
  1894. // Give priority to files in this folder by merging them in after any subdirectory files.
  1895. $files = array_merge(file_scan_directory($uri, $mask, $options, $depth + 1), $files);
  1896. }
  1897. elseif ($depth >= $options['min_depth'] && preg_match($mask, $filename)) {
  1898. // Always use this match over anything already set in $files with the
  1899. // same $$options['key'].
  1900. $file = new stdClass();
  1901. $file->uri = $uri;
  1902. $file->filename = $filename;
  1903. $file->name = pathinfo($filename, PATHINFO_FILENAME);
  1904. $key = $options['key'];
  1905. $files[$file->$key] = $file;
  1906. if ($options['callback']) {
  1907. $options['callback']($uri);
  1908. }
  1909. }
  1910. }
  1911. }
  1912. closedir($handle);
  1913. }
  1914. return $files;
  1915. }
  1916. /**
  1917. * Determines the maximum file upload size by querying the PHP settings.
  1918. *
  1919. * @return
  1920. * A file size limit in bytes based on the PHP upload_max_filesize and
  1921. * post_max_size
  1922. */
  1923. function file_upload_max_size() {
  1924. static $max_size = -1;
  1925. if ($max_size < 0) {
  1926. // Start with post_max_size.
  1927. $max_size = parse_size(ini_get('post_max_size'));
  1928. // If upload_max_size is less, then reduce. Except if upload_max_size is
  1929. // zero, which indicates no limit.
  1930. $upload_max = parse_size(ini_get('upload_max_filesize'));
  1931. if ($upload_max > 0 && $upload_max < $max_size) {
  1932. $max_size = $upload_max;
  1933. }
  1934. }
  1935. return $max_size;
  1936. }
  1937. /**
  1938. * Determines an Internet Media Type or MIME type from a filename.
  1939. *
  1940. * @param $uri
  1941. * A string containing the URI, path, or filename.
  1942. * @param $mapping
  1943. * An optional map of extensions to their mimetypes, in the form:
  1944. * - 'mimetypes': a list of mimetypes, keyed by an identifier,
  1945. * - 'extensions': the mapping itself, an associative array in which
  1946. * the key is the extension (lowercase) and the value is the mimetype
  1947. * identifier. If $mapping is NULL file_mimetype_mapping() is called.
  1948. *
  1949. * @return
  1950. * The internet media type registered for the extension or
  1951. * application/octet-stream for unknown extensions.
  1952. *
  1953. * @see file_default_mimetype_mapping()
  1954. */
  1955. function file_get_mimetype($uri, $mapping = NULL) {
  1956. if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) {
  1957. return $wrapper->getMimeType($uri, $mapping);
  1958. }
  1959. else {
  1960. // getMimeType() is not implementation specific, so we can directly
  1961. // call it without an instance.
  1962. return DrupalLocalStreamWrapper::getMimeType($uri, $mapping);
  1963. }
  1964. }
  1965. /**
  1966. * Sets the permissions on a file or directory.
  1967. *
  1968. * This function will use the 'file_chmod_directory' and 'file_chmod_file'
  1969. * variables for the default modes for directories and uploaded/generated
  1970. * files. By default these will give everyone read access so that users
  1971. * accessing the files with a user account without the webserver group (e.g.
  1972. * via FTP) can read these files, and give group write permissions so webserver
  1973. * group members (e.g. a vhost account) can alter files uploaded and owned by
  1974. * the webserver.
  1975. *
  1976. * PHP's chmod does not support stream wrappers so we use our wrapper
  1977. * implementation which interfaces with chmod() by default. Contrib wrappers
  1978. * may override this behavior in their implementations as needed.
  1979. *
  1980. * @param $uri
  1981. * A string containing a URI file, or directory path.
  1982. * @param $mode
  1983. * Integer value for the permissions. Consult PHP chmod() documentation for
  1984. * more information.
  1985. *
  1986. * @return
  1987. * TRUE for success, FALSE in the event of an error.
  1988. *
  1989. * @ingroup php_wrappers
  1990. */
  1991. function drupal_chmod($uri, $mode = NULL) {
  1992. if (!isset($mode)) {
  1993. if (is_dir($uri)) {
  1994. $mode = variable_get('file_chmod_directory', 0775);
  1995. }
  1996. else {
  1997. $mode = variable_get('file_chmod_file', 0664);
  1998. }
  1999. }
  2000. // If this URI is a stream, pass it off to the appropriate stream wrapper.
  2001. // Otherwise, attempt PHP's chmod. This allows use of drupal_chmod even
  2002. // for unmanaged files outside of the stream wrapper interface.
  2003. if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) {
  2004. if ($wrapper->chmod($mode)) {
  2005. return TRUE;
  2006. }
  2007. }
  2008. else {
  2009. if (@chmod($uri, $mode)) {
  2010. return TRUE;
  2011. }
  2012. }
  2013. watchdog('file', 'The file permissions could not be set on %uri.', array('%uri' => $uri), WATCHDOG_ERROR);
  2014. return FALSE;
  2015. }
  2016. /**
  2017. * Deletes a file.
  2018. *
  2019. * PHP's unlink() is broken on Windows, as it can fail to remove a file
  2020. * when it has a read-only flag set.
  2021. *
  2022. * @param $uri
  2023. * A URI or pathname.
  2024. * @param $context
  2025. * Refer to http://php.net/manual/en/ref.stream.php
  2026. *
  2027. * @return
  2028. * Boolean TRUE on success, or FALSE on failure.
  2029. *
  2030. * @see unlink()
  2031. * @ingroup php_wrappers
  2032. */
  2033. function drupal_unlink($uri, $context = NULL) {
  2034. $scheme = file_uri_scheme($uri);
  2035. if ((!$scheme || !file_stream_wrapper_valid_scheme($scheme)) && (substr(PHP_OS, 0, 3) == 'WIN')) {
  2036. chmod($uri, 0600);
  2037. }
  2038. if ($context) {
  2039. return unlink($uri, $context);
  2040. }
  2041. else {
  2042. return unlink($uri);
  2043. }
  2044. }
  2045. /**
  2046. * Returns the absolute local filesystem path of a stream URI.
  2047. *
  2048. * This function was originally written to ease the conversion of 6.x code to
  2049. * use 7.x stream wrappers. However, it assumes that every URI may be resolved
  2050. * to an absolute local filesystem path, and this assumption fails when stream
  2051. * wrappers are used to support remote file storage. Remote stream wrappers
  2052. * may implement the realpath method by always returning FALSE. The use of
  2053. * drupal_realpath() is discouraged, and is slowly being removed from core
  2054. * functions where possible.
  2055. *
  2056. * Only use this function if you know that the stream wrapper in the URI uses
  2057. * the local file system, and you need to pass an absolute path to a function
  2058. * that is incompatible with stream URIs.
  2059. *
  2060. * @param $uri
  2061. * A stream wrapper URI or a filesystem path, possibly including one or more
  2062. * symbolic links.
  2063. *
  2064. * @return
  2065. * The absolute local filesystem path (with no symbolic links), or FALSE on
  2066. * failure.
  2067. *
  2068. * @todo This function is deprecated, and should be removed wherever possible.
  2069. *
  2070. * @see DrupalStreamWrapperInterface::realpath()
  2071. * @see http://php.net/manual/function.realpath.php
  2072. * @ingroup php_wrappers
  2073. */
  2074. function drupal_realpath($uri) {
  2075. // If this URI is a stream, pass it off to the appropriate stream wrapper.
  2076. // Otherwise, attempt PHP's realpath. This allows use of drupal_realpath even
  2077. // for unmanaged files outside of the stream wrapper interface.
  2078. if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) {
  2079. return $wrapper->realpath();
  2080. }
  2081. // Check that the uri has a value. There is a bug in PHP 5.2 on *BSD systems
  2082. // that makes realpath not return FALSE as expected when passing an empty
  2083. // variable.
  2084. // @todo Remove when Drupal drops support for PHP 5.2.
  2085. elseif (!empty($uri)) {
  2086. return realpath($uri);
  2087. }
  2088. return FALSE;
  2089. }
  2090. /**
  2091. * Gets the name of the directory from a given path.
  2092. *
  2093. * PHP's dirname() does not properly pass streams, so this function fills
  2094. * that gap. It is backwards compatible with normal paths and will use
  2095. * PHP's dirname() as a fallback.
  2096. *
  2097. * Compatibility: normal paths and stream wrappers.
  2098. *
  2099. * @param $uri
  2100. * A URI or path.
  2101. *
  2102. * @return
  2103. * A string containing the directory name.
  2104. *
  2105. * @see dirname()
  2106. * @see http://drupal.org/node/515192
  2107. * @ingroup php_wrappers
  2108. */
  2109. function drupal_dirname($uri) {
  2110. $scheme = file_uri_scheme($uri);
  2111. if ($scheme && file_stream_wrapper_valid_scheme($scheme)) {
  2112. return file_stream_wrapper_get_instance_by_scheme($scheme)->dirname($uri);
  2113. }
  2114. else {
  2115. return dirname($uri);
  2116. }
  2117. }
  2118. /**
  2119. * Gets the filename from a given path.
  2120. *
  2121. * PHP's basename() does not properly support streams or filenames beginning
  2122. * with a non-US-ASCII character.
  2123. *
  2124. * @see http://bugs.php.net/bug.php?id=37738
  2125. * @see basename()
  2126. *
  2127. * @ingroup php_wrappers
  2128. */
  2129. function drupal_basename($uri, $suffix = NULL) {
  2130. $separators = '/';
  2131. if (DIRECTORY_SEPARATOR != '/') {
  2132. // For Windows OS add special separator.
  2133. $separators .= DIRECTORY_SEPARATOR;
  2134. }
  2135. // Remove right-most slashes when $uri points to directory.
  2136. $uri = rtrim($uri, $separators);
  2137. // Returns the trailing part of the $uri starting after one of the directory
  2138. // separators.
  2139. $filename = preg_match('@[^' . preg_quote($separators, '@') . ']+$@', $uri, $matches) ? $matches[0] : '';
  2140. // Cuts off a suffix from the filename.
  2141. if ($suffix) {
  2142. $filename = preg_replace('@' . preg_quote($suffix, '@') . '$@', '', $filename);
  2143. }
  2144. return $filename;
  2145. }
  2146. /**
  2147. * Creates a directory using Drupal's default mode.
  2148. *
  2149. * PHP's mkdir() does not respect Drupal's default permissions mode. If a mode
  2150. * is not provided, this function will make sure that Drupal's is used.
  2151. *
  2152. * Compatibility: normal paths and stream wrappers.
  2153. *
  2154. * @param $uri
  2155. * A URI or pathname.
  2156. * @param $mode
  2157. * By default the Drupal mode is used.
  2158. * @param $recursive
  2159. * Default to FALSE.
  2160. * @param $context
  2161. * Refer to http://php.net/manual/en/ref.stream.php
  2162. *
  2163. * @return
  2164. * Boolean TRUE on success, or FALSE on failure.
  2165. *
  2166. * @see mkdir()
  2167. * @see http://drupal.org/node/515192
  2168. * @ingroup php_wrappers
  2169. */
  2170. function drupal_mkdir($uri, $mode = NULL, $recursive = FALSE, $context = NULL) {
  2171. if (!isset($mode)) {
  2172. $mode = variable_get('file_chmod_directory', 0775);
  2173. }
  2174. if (!isset($context)) {
  2175. return mkdir($uri, $mode, $recursive);
  2176. }
  2177. else {
  2178. return mkdir($uri, $mode, $recursive, $context);
  2179. }
  2180. }
  2181. /**
  2182. * Removes a directory.
  2183. *
  2184. * PHP's rmdir() is broken on Windows, as it can fail to remove a directory
  2185. * when it has a read-only flag set.
  2186. *
  2187. * @param $uri
  2188. * A URI or pathname.
  2189. * @param $context
  2190. * Refer to http://php.net/manual/en/ref.stream.php
  2191. *
  2192. * @return
  2193. * Boolean TRUE on success, or FALSE on failure.
  2194. *
  2195. * @see rmdir()
  2196. * @ingroup php_wrappers
  2197. */
  2198. function drupal_rmdir($uri, $context = NULL) {
  2199. $scheme = file_uri_scheme($uri);
  2200. if ((!$scheme || !file_stream_wrapper_valid_scheme($scheme)) && (substr(PHP_OS, 0, 3) == 'WIN')) {
  2201. chmod($uri, 0700);
  2202. }
  2203. if ($context) {
  2204. return rmdir($uri, $context);
  2205. }
  2206. else {
  2207. return rmdir($uri);
  2208. }
  2209. }
  2210. /**
  2211. * Creates a file with a unique filename in the specified directory.
  2212. *
  2213. * PHP's tempnam() does not return a URI like we want. This function
  2214. * will return a URI if given a URI, or it will return a filepath if
  2215. * given a filepath.
  2216. *
  2217. * Compatibility: normal paths and stream wrappers.
  2218. *
  2219. * @param $directory
  2220. * The directory where the temporary filename will be created.
  2221. * @param $prefix
  2222. * The prefix of the generated temporary filename.
  2223. * Note: Windows uses only the first three characters of prefix.
  2224. *
  2225. * @return
  2226. * The new temporary filename, or FALSE on failure.
  2227. *
  2228. * @see tempnam()
  2229. * @see http://drupal.org/node/515192
  2230. * @ingroup php_wrappers
  2231. */
  2232. function drupal_tempnam($directory, $prefix) {
  2233. $scheme = file_uri_scheme($directory);
  2234. if ($scheme && file_stream_wrapper_valid_scheme($scheme)) {
  2235. $wrapper = file_stream_wrapper_get_instance_by_scheme($scheme);
  2236. if ($filename = tempnam($wrapper->getDirectoryPath(), $prefix)) {
  2237. return $scheme . '://' . drupal_basename($filename);
  2238. }
  2239. else {
  2240. return FALSE;
  2241. }
  2242. }
  2243. else {
  2244. // Handle as a normal tempnam() call.
  2245. return tempnam($directory, $prefix);
  2246. }
  2247. }
  2248. /**
  2249. * Gets the path of system-appropriate temporary directory.
  2250. */
  2251. function file_directory_temp() {
  2252. $temporary_directory = variable_get('file_temporary_path', NULL);
  2253. if (empty($temporary_directory)) {
  2254. $directories = array();
  2255. // Has PHP been set with an upload_tmp_dir?
  2256. if (ini_get('upload_tmp_dir')) {
  2257. $directories[] = ini_get('upload_tmp_dir');
  2258. }
  2259. // Operating system specific dirs.
  2260. if (substr(PHP_OS, 0, 3) == 'WIN') {
  2261. $directories[] = 'c:\\windows\\temp';
  2262. $directories[] = 'c:\\winnt\\temp';
  2263. }
  2264. else {
  2265. $directories[] = '/tmp';
  2266. }
  2267. // PHP may be able to find an alternative tmp directory.
  2268. // This function exists in PHP 5 >= 5.2.1, but Drupal
  2269. // requires PHP 5 >= 5.2.0, so we check for it.
  2270. if (function_exists('sys_get_temp_dir')) {
  2271. $directories[] = sys_get_temp_dir();
  2272. }
  2273. foreach ($directories as $directory) {
  2274. if (is_dir($directory) && is_writable($directory)) {
  2275. $temporary_directory = $directory;
  2276. break;
  2277. }
  2278. }
  2279. if (empty($temporary_directory)) {
  2280. // If no directory has been found default to 'files/tmp'.
  2281. $temporary_directory = variable_get('file_public_path', conf_path() . '/files') . '/tmp';
  2282. // Windows accepts paths with either slash (/) or backslash (\), but will
  2283. // not accept a path which contains both a slash and a backslash. Since
  2284. // the 'file_public_path' variable may have either format, we sanitize
  2285. // everything to use slash which is supported on all platforms.
  2286. $temporary_directory = str_replace('\\', '/', $temporary_directory);
  2287. }
  2288. // Save the path of the discovered directory.
  2289. variable_set('file_temporary_path', $temporary_directory);
  2290. }
  2291. return $temporary_directory;
  2292. }
  2293. /**
  2294. * Examines a file object and returns appropriate content headers for download.
  2295. *
  2296. * @param $file
  2297. * A file object.
  2298. *
  2299. * @return
  2300. * An associative array of headers, as expected by file_transfer().
  2301. */
  2302. function file_get_content_headers($file) {
  2303. $name = mime_header_encode($file->filename);
  2304. $type = mime_header_encode($file->filemime);
  2305. // Serve images, text, and flash content for display rather than download.
  2306. $inline_types = variable_get('file_inline_types', array('^text/', '^image/', 'flash$'));
  2307. $disposition = 'attachment';
  2308. foreach ($inline_types as $inline_type) {
  2309. // Exclamation marks are used as delimiters to avoid escaping slashes.
  2310. if (preg_match('!' . $inline_type . '!', $file->filemime)) {
  2311. $disposition = 'inline';
  2312. }
  2313. }
  2314. return array(
  2315. 'Content-Type' => $type . '; name="' . $name . '"',
  2316. 'Content-Length' => $file->filesize,
  2317. 'Content-Disposition' => $disposition . '; filename="' . $name . '"',
  2318. 'Cache-Control' => 'private',
  2319. );
  2320. }
  2321. /**
  2322. * @} End of "defgroup file".
  2323. */