romanpitak / nginx-config-processor

PHP Nginx configuration files processor (parser, creator, generator).

Nginx Configuration Processor

(c) 2014-2016 Roman Piták [email protected]

PHP Nginx configuration files processor (parser, creator).

Installation

The best way to install is to use the Composer dependency manager.

php composer.phar require romanpitak/nginx-config-processor

Features

Pretty Print

<?php Scope::fromFile('m1.conf')->saveToFile('out.conf');

Config Create

<?php
Scope::create()
    ->addDirective(Directive::create('server')
        ->setChildScope(Scope::create()
            ->addDirective(Directive::create('listen', 8080))
            ->addDirective(Directive::create('server_name', 'example.net'))
            ->addDirective(Directive::create('root', 'C:/www/example_net'))
            ->addDirective(Directive::create('location', '^~ /var/', Scope::create()
                    ->addDirective(Directive::create('deny', 'all'))
                )->setCommentText('Deny access for location /var/')
            )
        )
    )
    ->saveToFile('example.net');

File example.net:

server {
    listen 8080;
    server_name example.net;
    root C:/www/example_net;
    location ^~ /var/ { # Deny access for location /var/
        deny all;
    }
}

Comments handling

Simple comments

<?php echo new Comment("This is a simple comment.");

output:

# This is a simple comment.

Multi-line comments

<?php
echo new Comment("This \nis \r\na multi
line " . PHP_EOL . "comment.");

output:

# This
# is
# a multi
# line
# comment.

Directive with a simple comment

<?php echo Directive::create('deny', 'all')->setCommentText('Directive with a comment');

output:

deny all; # Directive with a comment

Directive with a multi-line comment

<?php echo Directive::create('deny', 'all')->setCommentText('Directive
with a multi line comment');

output:

# Directive
# with a multi line comment
deny all;

nginx-config-processor's Issues

Empty comments

Short scopes on one line

Printing the short (one directive) scopes on the same line as the directive that contains them.

Pregmatch bug/error

The project is nice, in fact the only one... but your pregmatch is bugged.

https://github.com/romanpitak/Nginx-Config-Processor/blob/master/src/Directive.php -> checkKey:

1. / An unescaped delimiter must be escaped with a backslash ()

Plenty more... but I leave you to decide if you want to continue this, and fix it.

Good luck

Cannot use 'String' as class name as it is reserved

Not working in php-7

Cannot use 'String' as class name as it is reserved

how to parse the nginx config?

hello, i had read your project , and i havn't see how to parse nginx config,if this project can do this thing ?

Multiple comments per directive

Allow the Directive to store multiple assigned comments:

• the "Above Directive Comment" or comment block
• the "In-line Comment"
• the "End of Scope Comment"
  And implement the correct printing of the comments with appropriate printing rules.

Save Scope into a file.

Ability to save Scope into a File

Follow "include" directive

Ability to follow the include directive.

prettyPrint(0) is adding indent

It's mostly a question, not a bug... why prettyPrint(0) adding indent to each line?

I'm adding prettyPrint(-1) to avoid this behavior.

How can I create proxy_set_header?

I would like create config like this

location / {
proxy_pass http://localhost:8000;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
}

but how can I create proxy_set_header X-Real-IP $remote_addr; ?

Directive::create('proxy_set_header', 'X-Real-IP', '$remote_addr')

does not do the job.

http://nginx.org/en/docs/http/ngx_http_proxy_module.html

Update config

Is there is a way to update directives values or append directives to existing ones?