1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>filetest - perldoc.perl.org</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Language" content="en-gb">
<link href="static/css-20090810.css" rel="stylesheet" rev="stylesheet" type="text/css" media="screen">
</head>
<body onLoad="perldoc.startup();" onPageShow="if (event.persisted) perldoc.startup();">
<div id="page">
<div id="header">
<div id="homepage_link">
<a href="index.html"></a>
</div>
<div id="search_form">
<form action="search.html" method="GET" id="search">
<input type="text" name="q" id="search_box" alt="Search">
</form>
</div>
</div>
<div id="body">
<div id="left_column">
<div class="side_group">
<div class="side_panel doc_panel">
<p>Manual</p>
<ul>
<li><a href="index-overview.html">Overview</a>
<li><a href="index-tutorials.html">Tutorials</a>
<li><a href="index-faq.html">FAQs</a>
<li><a href="index-history.html">History / Changes</a>
<li><a href="index-licence.html">License</a>
</ul>
</div>
<div class="side_panel doc_panel">
<p>Reference</p>
<ul>
<li><a href="index-language.html">Language</a>
<li><a href="index-functions.html">Functions</a>
<li><a href="perlop.html">Operators</a>
<li><a href="perlvar.html">Special Variables</a>
<li><a href="index-pragmas.html">Pragmas</a>
<li><a href="index-utilities.html">Utilities</a>
<li><a href="index-internals.html">Internals</a></li>
<li><a href="index-platforms.html">Platform Specific</a>
</ul>
</div>
<div class="side_panel doc_panel">
<p>Modules</p>
<ul>
<li>
<a href="index-modules-A.html">A</a>
•
<a href="index-modules-B.html">B</a>
•
<a href="index-modules-C.html">C</a>
•
<a href="index-modules-D.html">D</a>
•
<a href="index-modules-E.html">E</a>
<li>
<a href="index-modules-F.html">F</a>
•
<a href="index-modules-G.html">G</a>
•
<a href="index-modules-H.html">H</a>
•
<a href="index-modules-I.html">I</a>
•
<a href="index-modules-L.html">L</a>
<li>
<a href="index-modules-M.html">M</a>
•
<a href="index-modules-N.html">N</a>
•
<a href="index-modules-O.html">O</a>
•
<a href="index-modules-P.html">P</a>
•
<a href="index-modules-S.html">S</a>
<li>
<a href="index-modules-T.html">T</a>
•
<a href="index-modules-U.html">U</a>
•
<a href="index-modules-X.html">X</a>
</ul>
</div>
</div>
<div class="side_group">
<div class="side_panel links_panel">
<p>News / Blogs</p>
<ul>
<li><a href="http://perlbuzz.com">Perl Buzz</a></li>
<li><a href="http://ironman.enlightenedperl.org">Perl Iron Man</a></li>
<li><a href="http://perlsphere.net">Perlsphere</a></li>
<li><a href="http://planet.perl.org">Planet Perl</a></li>
<li><a href="http://news.perlfoundation.org/">TPF news</a></li>
<li><a href="http://use.perl.org">Use Perl</a></li>
</ul>
</div>
<div class="side_panel links_panel">
<p>See also</p>
<ul>
<li><a href="http://search.cpan.org">CPAN</a></li>
<li><a href="http://www.perl.org">Perl.org</a></li>
<li><a href="http://www.perl.com">Perl.com</a></li>
<li><a href="http://www.perlfoundation.org/perl5/index.cgi">Perl 5 Wiki</a></li>
<li><a href="http://jobs.perl.org">Perl Jobs</a></li>
<li><a href="http://www.pm.org">Perl Mongers</a></li>
<li><a href="http://www.perlmonks.org">Perl Monks</a></li>
</ul>
</div>
<div class="side_panel links_panel">
<p>Contact</p>
<ul>
<li><a href="http://perl.jonallen.info">Site designed and maintained by Jon Allen (JJ)</a>
<li><a href="http://perl.jonallen.info">http://perl.jonallen.info</a>
</ul>
<ul>
<li><a href="http://perl.jonallen.info/projects/perldoc">View the project page and FAQs</a>
</ul>
</div>
</div>
</div>
<div id="centre_column">
<div id="content_header">
<div id="title_bar">
<div id="page_name">
<h1>filetest</h1>
</div>
<div id="perl_version">
Perl 5 version 10.1 documentation
</div>
<div id="page_links">
<a href="#" onClick="toolbar.goToTop();return false;">Go to top</a>
• <a href="#" id="page_index_toggle">Show page index</a>
</div>
</div>
<div id="breadcrumbs">
<a href="index.html">Home</a> >
<a href="index-pragmas.html">Pragmas</a> >
filetest
</div>
</div>
<div id="content_body">
<!--[if lt IE 7]>
<div class="noscript">
<p>
<strong>It looks like you're using Internet Explorer 6. This is a very old
browser which does not offer full support for modern websites.</strong>
</p>
<p>
Unfortunately this means that this website will not work on
your computer.
</p>
<p>
Don't miss out though! To view the site (and get a better experience from
many other websites), simply upgrade to
<a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet
Explorer 8</a>
or download an alternative browser such as
<a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>,
<a href="http://www.apple.com/safari/download/">Safari</a>, or
<a href="http://www.google.co.uk/chrome">Google Chrome</a>.
</p>
<p>
All of these browsers are free. If you're using a PC at work, you may
need to contact your IT administrator.
</p>
</div>
<![endif]-->
<noscript>
<div class="noscript">
<p>
<strong>Please note: Many features of this site require JavaScript. You appear to have JavaScript disabled,
or are running a non-JavaScript capable web browser.</strong>
</p>
<p>
To get the best experience, please enable JavaScript or download a modern web browser such as <a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet Explorer 8</a>, <a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>, <a href="http://www.apple.com/safari/download/">Safari</a>, or <a href="http://www.google.co.uk/chrome">Google Chrome</a>.
</p>
</div>
</noscript>
<div id="from_search"></div>
<h1>filetest</h1>
<!-- -->
<ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Consider-this-carefully">Consider this carefully</a><li><a href="#The-%22access%22-sub-pragma">The "access" sub-pragma</a><li><a href="#Limitation-with-regard-to-_">Limitation with regard to _</a></ul></ul><a name="NAME"></a><h1>NAME</h1>
<p>filetest - Perl pragma to control the filetest permission operators</p>
<a name="SYNOPSIS"></a><h1>SYNOPSIS</h1>
<pre class="verbatim"><ol><li> <span class="i">$can_perhaps_read</span> = -r <span class="q">"file"</span><span class="sc">;</span> <span class="c"># use the mode bits</span></li><li> <span class="s">{</span></li><li> <a class="l_k" href="functions/use.html">use</a> <span class="w">filetest</span> <span class="q">'access'</span><span class="sc">;</span> <span class="c"># intuit harder</span></li><li> <span class="i">$can_really_read</span> = -r <span class="q">"file"</span><span class="sc">;</span></li><li> <span class="s">}</span></li><li> <span class="i">$can_perhaps_read</span> = -r <span class="q">"file"</span><span class="sc">;</span> <span class="c"># use the mode bits again</span></li></ol></pre><a name="DESCRIPTION"></a><h1>DESCRIPTION</h1>
<p>This pragma tells the compiler to change the behaviour of the filetest
permission operators, <code class="inline">-r</code>
<code class="inline">-w</code>
<code class="inline">-x</code>
<code class="inline">-R</code>
<code class="inline">-W</code>
<code class="inline"><a class="l_k" href="functions/-X.html">-X</a></code>
(see <a href="perlfunc.html">perlfunc</a>).</p>
<p>The default behaviour of file test operators is to use the simple
mode bits as returned by the stat() family of system calls. However,
many operating systems have additional features to define more complex
access rights, for example ACLs (Access Control Lists).
For such environments, <code class="inline"><a class="l_k" href="functions/use.html">use</a> <span class="w">filetest</span></code>
may help the permission
operators to return results more consistent with other tools.</p>
<p>The <code class="inline"><a class="l_k" href="functions/use.html">use</a> <span class="w">filetest</span></code>
or <code class="inline"><a class="l_k" href="functions/no.html">no</a> <span class="w">filetest</span></code>
statements affect file tests defined in
their block, up to the end of the closest enclosing block (they are lexically
block-scoped).</p>
<p>Currently, only the <code class="inline"><span class="w">access</span></code>
sub-pragma is implemented. It enables (or
disables) the use of access() when available, that is, on most UNIX systems and
other POSIX environments. See details below.</p>
<a name="Consider-this-carefully"></a><h2>Consider this carefully</h2>
<p>The stat() mode bits are probably right for most of the files and
directories found on your system, because few people want to use the
additional features offered by access(). But you may encounter surprises
if your program runs on a system that uses ACLs, since the stat()
information won't reflect the actual permissions.</p>
<p>There may be a slight performance decrease in the filetest operations
when the filetest pragma is in effect, because checking bits is very
cheap.</p>
<p>Also, note that using the file tests for security purposes is a lost cause
from the start: there is a window open for race conditions (who is to
say that the permissions will not change between the test and the real
operation?). Therefore if you are serious about security, just try
the real operation and test for its success - think in terms of atomic
operations. Filetests are more useful for filesystem administrative
tasks, when you have no need for the content of the elements on disk.</p>
<a name="The-%22access%22-sub-pragma"></a><h2>The "access" sub-pragma</h2>
<p>UNIX and POSIX systems provide an abstract access() operating system call,
which should be used to query the read, write, and execute rights. This
function hides various distinct approaches in additional operating system
specific security features, like Access Control Lists (ACLs)</p>
<p>The extended filetest functionality is used by Perl only when the argument
of the operators is a filename, not when it is a filehandle.</p>
<a name="Limitation-with-regard-to-_"></a><h2>Limitation with regard to <code class="inline"><span class="w">_</span></code>
</h2>
<p>Because access() does not invoke stat() (at least not in a way visible
to Perl), <b>the stat result cache "_" is not set</b>. This means that the
outcome of the following two tests is different. The first has the stat
bits of <code class="inline">/etc/passwd</code> in <code class="inline"><span class="w">_</span></code>
, and in the second case this still
contains the bits of <code class="inline">/etc</code>.</p>
<pre class="verbatim"><ol><li> <span class="s">{</span> -d <span class="q">'/etc'</span><span class="sc">;</span></li><li> -w <span class="q">'/etc/passwd'</span><span class="sc">;</span></li><li> <a class="l_k" href="functions/print.html">print</a> -f <span class="i">_</span> ? <span class="q">'Yes'</span> <span class="co">:</span> <span class="q">'No'</span><span class="sc">;</span> <span class="c"># Yes</span></li><li> <span class="s">}</span></li><li></li><li> <span class="s">{</span> <a class="l_k" href="functions/use.html">use</a> <span class="w">filetest</span> <span class="q">'access'</span><span class="sc">;</span></li><li> -d <span class="q">'/etc'</span><span class="sc">;</span></li><li> -w <span class="q">'/etc/passwd'</span><span class="sc">;</span></li><li> <a class="l_k" href="functions/print.html">print</a> -f <span class="i">_</span> ? <span class="q">'Yes'</span> <span class="co">:</span> <span class="q">'No'</span><span class="sc">;</span> <span class="c"># No</span></li><li> <span class="s">}</span></li></ol></pre><p>Of course, unless your OS does not implement access(), in which case the
pragma is simply ignored. Best not to use <code class="inline"><span class="w">_</span></code>
at all in a file where
the filetest pragma is active!</p>
<p>As a side effect, as <code class="inline"><span class="w">_</span></code>
doesn't work, stacked filetest operators
(<code class="inline">-f -w <span class="i">$file</span></code>
) won't work either.</p>
<p>This limitation might be removed in a future version of perl.</p>
<div id="page_index">
<div id="page_index_header">
<div id="page_index_close"><a href="#" onClick="pageIndex.hide();return false;"></a></div>
<div id="page_index_title"><span class="page_index_top">Page index</span></div>
<div id="page_index_topright"></div>
</div>
<div id="page_index_content">
<ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Consider-this-carefully">Consider this carefully</a><li><a href="#The-%22access%22-sub-pragma">The "access" sub-pragma</a><li><a href="#Limitation-with-regard-to-_">Limitation with regard to _</a></ul></ul>
</div>
<div id="page_index_footer">
<div id="page_index_bottomleft"></div>
<div id="page_index_bottom"><span class="page_index_bottom"></span></div>
<div id="page_index_resize"></div>
</div>
</div>
</div>
<div id="content_footer">
</div>
</div>
<div id="right_column">
<div class="side_group">
<div class="side_panel tools_panel">
<p>Recently read</p>
<div id="recent_pages"></div>
</div>
<div class="side_panel tools_panel">
<p>Tools</p>
<ul>
<li><a href="preferences.html">Preferences</a>
</ul>
</div>
</div>
</div>
<div class="clear"></div>
</div>
<div id="footer">
<div id="footer_content">
</div>
</div>
</div>
<script language="JavaScript" src="static/combined-20090809.js" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
perldoc.setPath(0);
perldoc.pageName = 'filetest';
perldoc.pageAddress = 'filetest.html';
perldoc.contentPage = 1;
</script>
</body>
</html>
|