PHP - File Permissions

The concept of permissions is at the core of Unix/Linux file system. The permissions determine who can access a file and how one can access a file. File permissions in Linux are manipulated by thechmod command, which can be run inside the Linux terminal. PHP provides thechmod() functionwith which you can handle file permissions programmatically.

PHP’s chmod() function is effective only when you are working on a Linux OS. It doesn’t work on Windows, as Windows OS has a different mechanism of controlling file permissions.

To view the permissions enabled on a file, obtain the list of files using the “ls -l” command (long listing)

PHP CODE

mvl@GNVBGL3:~$ ls -l

-rwxr-xr-x 1 mvl mvl 16376 May  5 21:52 a.out
-rw-r--r-- 1 mvl mvl    83 May  5 21:52 hello.cpp
-rwxr-xr-x 1 mvl mvl    43 Oct 11 14:50 hello.php
-rwxr-xr-x 1 mvl mvl    43 May  8 10:01 hello.py
drwxr-xr-x 5 mvl mvl  4096 Apr 20 21:52 myenv

The first column contains permission flags of each file. Third and fourth columns indicate the owner and group of each file, followed by size, date and time, and the file name.

The permissions string has ten characters, their meaning is described as follows −

PositionMeaning1”d” if a directory, ”-” if a normal file2, 3, 4read, write, execute permission for user (owner) of file5, 6, 7read, write, execute permission for group8, 9, 10read, write, execute permission for other (world)

The characters in the permission string have following meaning −

ValueMeaning-Flag is not set.rFile is readable.wFile is writable. For directories, files may be created or removed.xFile is executable. For directories, files may be listed.

If you consider the first entry in the above list −

PHP CODE

-rwxr-xr-x 1 mvl mvl 16376 May  5 21:52 a.out

The “a.out” file is owned by the user “mvl” and group “mvl”. It is a normal file with “read/write/execute” permissions for the owner, and “read/ execute” permissions for the group as well as others.

The binary and octal representation of permission flags can be understood with the following table −

Octal DigitBinary Representation (rwx)Permission0000none1001execute only2010write only3011write and execute4100read only5101read and execute6110read and write7111read, write, and execute (full permissions)

The chmod() Function

The chmod() function can change permissions of a specified file. It returnstrueon success, otherwisefalseon failure.

PHP CODE

chmod(string $filename, int $permissions): bool

The chmod() function attempts to change the mode of the specified file ($filename) to that given in permissions.

The second parameter$permissionsis an octal number with four octal digits. The first digit is always zero, second specifies permissions for the owner, third for the owner’s user group and fourth for everybody else. Each digit is the sum of values for each type of permission.

1Execute Permission2Write Permission4Read Permission

The default value of$permissionsparameters is0777, which means the directory is created with execute, write and read permissions enabled.

Example

Take a look at the following example −

PHP CODE

&lt;?php

   // Read and write for owner, nothing for everybody else
   chmod("/PhpProject/sample.txt", 0600);

   // Read and write for owner, read for everybody else
   chmod("/PhpProject/sample.txt", 0644);

   // Everything for owner, read and execute for everybody else
   chmod("/PhpProject/sample.txt", 0755);

   // Everything for owner, read for owner's group
   chmod("/PhpProject/sample.txt", 0740);
?&gt;

The chown() Function

The chown() function attempts to change the owner of the file filename to a new user. Note that only the superuser may change the owner of a file.

PHP CODE

chown(string $filename, string|int $user): bool

Example

Take a look at the following example −

PHP CODE

&amp;lt?php

   // File name and username to use
   $file_name= "index.php";
   $path = "/PhpProject/backup: " . $file_name ;
   $user_name = "root";

   // Set the user
   chown($path, $user_name);

   // Check the result
   $stat = stat($path);
   print_r(posix_getpwuid(fileowner($path)));
?&gt;

The chgrp() Function

The chgrp() function attempts to change the group of the file filename to group.

PHP CODE

chgrp(string $filename, string|int $group): bool

Only asuperusermay change the group of a file arbitrarily; other users may change the group of a file to any group of which that user is a member.

Example

Take a look at the following example −

PHP CODE

&lt;?php
   $filename = "/PhpProject/sample.txt";
   $format = "%s's Group ID @ %s: %d\n";
   printf($format, $filename, date('r'), filegroup($filename));
   chgrp($filename, "admin");
   clearstatcache();  	// do not cache filegroup() results
   printf($format, $filename, date('r'), filegroup($filename));
?&gt;

It will produce the followingoutput−

PHP CODE

/PhpProject/sample.txt's Group ID @ Fri, 13 Oct 2023 07:42:21 +0200: 0
/PhpProject/sample.txt's Group ID @ Fri, 13 Oct 2023 07:42:21 +0200: 0