Программирование в PHP для командной строки

Предисловие

Ubuntu предоставляет в комплекте с пакетом apache2 утилиты для включения\выключения виртуальных хостов и модулей. Однако, создание конфигов для виртуальных хостов отнимают дополнительное время. Поэтому, мне захотелось исправить этот недостаток. Можно было, конечно, сделать автоматические поддомены для апача, но я решил написать скрипт, который создает файлы конфигурации виртуальных хостов для апача, а так же, при необходимости, добавляет имя хоста в файл /etc/hosts. Я не очень хорошо пишу скрипты в bash'e, поэтому решил использовать PHP для моей довольно простой задачи, который я, к тому же, знаю довольно неплохо.
Итак, в этой статье мы сделаем сразу две полезных вещи: ознакомимся с операциями ввода\вывода командной строки в PHP и напишем скрипт, который совсем немного упростит нам жизнь.

Проверка прав доступа

Наверное, ни для кого не секрет, что достаточно просто в первой строке PHP скрипта написать
#!/usr/bin/env php
и такой скрипт можно будет выполнить как обычную программу в Linux.

Прежде всего, нам нужно проверить, есть ли у нас право на запись в ту самую папку, которая содержит в себе конфиги виртуальных хостов, а обычно для этого нужны root права. Проверить это довольно просто:

1. $virtual_hosts_dir = "/etc/apache2/sites-available/";
2. if (!is_dir($virtual_hosts_dir) || !is_writable($virtual_hosts_dir))
3. {
4.     echo "You must run this script as root!\n";
5.     exit;
6. }

Получение информации из параметров

Далее, нам необходимо узнать у пользователя некоторую информацию, которая нам нужна для создания конфига. Кроме последовательного ввода из консоли, можно передать эту информацию в качестве параметров, которые мы передаем при вызове скрипта. В PHP есть глобальные переменные $argc и $argv. Первая содержит количество входящих параметров, а вторая — массив со входящими параметрами. По-умолчанию входящий параметр всего один — полный путь к вызываемому скрипту. Таким образом, обработка входящих переменных сводится просто к обработке массива:

1. if ($argc>1) 
2. { 
3.     for ($i=1; $i<$argc; $i++) 
4.     { 
5.         $option = explode("=", $argv[$i]); 
6.         switch ($option[0]) 
7.         { 
8.             case "-h": 
9.             case "--add-to-hosts": 
10.                 $add_to_hosts = true; 
11.             break;
12.  
13.             case "-n": 
14.             case "--no-add-to-hosts": 
15.                 $add_to_hosts = false; 
16.             break;
17.  
18.             case "-a": 
19.             case "--server-alias": 
20.                 if (isset($option[1])) 
21.                 { 
22.                     $server_alias = $option[1]; 
23.                 } 
24.                 else 
25.                 { 
26.                     echo "Wrong option: {$argv[$i]}\n"; 
27.                 } 
28.             break;
29.  
30.             case "-d": 
31.             case "--document-root": 
32.                 if (isset($option[1])) 
33.                 { 
34.                     if ($option[1] == "default") 
35.                     { 
36.                         $document_root = $default_doc_root 
37.                     } 
38.                     else if (is_dir(dirname($option[1]))) 
39.                     { 
40.                         $document_root = $option[1]; 
41.                     } 
42.                 } 
43.                 else 
44.                 { 
45.                     echo "Wrong option: {$argv[$i]}\n"; 
46.                 } 
47.             break;
48.  
49.             default: 
50.                 if (substr($argv[$i], 1, 1) == '-') 
51.                 { 
52.                     echo "Unknown option: {$argv[$i]}\n"; 
53.                 } 
54.             break; 
55.         } 
56.     } 
57. }
58.  

Потоки ввода\вывода

Но не всегда ведь удобно вбивать кучу параметров в консоль. Поэтому теперь мы просим пользователя ввести с клавиатуры то, что нам до сих пор неизвестно. Для этого нам понадобятся потоки ввода\вывода, а в данном случае только ввода. В PHP для работы с потоками ввода\вывода используются константы STDIN, STDOUT, STDERR. По сути, эти потоки ничем не отличаются от файловых потоков и работать с ними так же просто. Например, строка:

1. $line = fgets(STDIN);

просто считает строку из консоли и запишет её в переменную $line. В данном случае, мы не открывали и не закрывали поток, т.к. PHP делает это автоматически. Но, мы можем открыть поток вручную и держать его открытым столько, сколько нам нужно. Это будет работать быстрее, если Вам нужно считать\записать более одной строки:

1. $stdin = fopen("php://stdin", "r");
2. $line1 = gets($stdin);
3. $line2 = gets($stdin);
4. fclose($stdin);

В данном случае мы сначала открываем поток, считываем из него две строки и закрываем его.
С записью аналогично, хотя я предпочитаю для вывода на экран просто использовать echo.

Продолжаем писать наш скрипт. Пока у нас нет хоть какой-то строки в качестве имени хоста, продолжаем просить пользователя, чтобы он что-то ввел:

1. while (!$server_alias)
2. {
3.     echo "Enter your hostname: ";
4.     $server_alias = trim(fgets(STDIN));
5. }

Теперь, спросим у пользователя, нужно ли добавлять информацию о этом хосте в /etc/hosts, но спрашиваем только в том случае, если эта информация не была передана в качестве параметра. Так как скрипт я писал себе для повседневной работы, то никаких реальных сайтов у меня не будет и чаще всего нужно будет добавлять хост в /etc/hosts, поэтому если мы ничего не вводим, а просто нажимаем Enter то это принимается как согласие:

1. if ($add_to_hosts === null)
2. {
3.     echo "Add $server_alias to your /etc/hosts ? (Y/N) [Y]: ";
4.     $line = trim(fgets(STDIN));
5.     if ($line == 'n' || $line == 'N')
6.     {
7.         $add_to_hosts = false;
8.     }
9.     else
10.     {
11.         $add_to_hosts = true;
12.     }
13. }

То же самое и с корневой директорией сайта:

1. if (!$document_root) 
2. { 
3.     $default_doc_root = $default_doc_root.'/'.$server_alias; 
4.     echo "Enter your document root [$default_doc_root]: "; 
5.     $line = trim(fgets(STDIN)); 
6.     if ($line && is_dir(dirname($line))) 
7.     { 
8.         $document_root = $line; 
9.     } 
10.     else 
11.     { 
12.         $document_root = $default_doc_root; 
13.     } 
14. }
15.  

Генерация конфиг-файла

На этом этапе весь сбор информации закончен и у нас есть все, что нужно, для того, чтобы создать конфиг. Надо убедится, что корневая директория сайта существует, а если её нет — создадим её:

1. if (!is_dir($document_root))
2. {
3.     mkdir($document_root);
4. }

Мы спрашивали у пользователя по поводу добавления хоста в /etc/hosts. Сделаем это, если он согласился:

1. if ($add_to_hosts)
2. {
3.     $hosts = file_get_contents("/etc/hosts");
4.     $hosts .= "127.0.0.1\t$server_alias\n";
5.     file_put_contents("/etc/hosts", $hosts);
6. }

Собственно так выглядит шаблон нашего конфига:

1. $host_template = <<<HOST
2. <VirtualHost *:80> 
3. ServerAdmin i@bogus.in 
4. ServerAlias $server_alias
5.  
6. DocumentRoot $document_root 
7. <Directory $document_root> 
8.     Options Indexes FollowSymLinks MultiViews 
9.     AllowOverride All 
10.     Order allow,deny 
11.     allow from all 
12. </Directory>
13.  
14. ErrorLog \${APACHE_LOG_DIR}/$server_alias-error.log; 
15. LogLevel warn 
16. CustomLog \${APACHE_LOG_DIR}/$server_alias-access.log combined
17. </VirtualHost>
18. HOST;
19.  

Ну и теперь просто запишем конфиг в файл и напомним пользователю о том, что конфиг теперь нужно еще и активировать с помощью a2ensite:

1. file_put_contents("/etc/apache2/sites-available/$server_alias", $host_template); 
2. echo "Apache config for this hostname created successfully! Don't forget to run a2ensite $server_alias\n";
3.  

Скрипт написан. Нужно сохранить его в файл и не забыть установить флаг +x, чтобы его можно было запускать как программу:
chmod +x a2addsite

Использование

Теперь скрипт можно использовать. Можно как вводить всю информацию в консоли:
% sudo ./a2addsite
Add test.local to your /etc/hosts? (Y/N) [Y]:
Enter your document root [/home/www/test.local]:
Apache config for this hostname created successfully! Don't forget to run a2ensite test.local

так передавать всю или часть информации скрипту в качестве параметров при вызове:
% sudo ./a2addsite --server-alias=test2.local --add-to-hosts --document-root=default
Apache config for this hostname created successfully! Don't forget to run a2ensite test2.local

Выводы

PHP можно использовать не только для разработки сайтов, но и для решения мелких локальных задач на компьютере. Скрипт я писал под себя и, наверняка, кто-то из Вас переделает его под свои нужды.
Исходный код скрипта

Литература

Больше информации о потоках ввода вывода, а также о остальных особенностях работы с консолью в PHP можно получить на официальном сайте PHP (англ.):
Command line usage
PHP input/output