Node Server Pages

Node Server Pages is a server-side script to create dynamic web pages based on Node.js.

Node Server Pages is NOT a template engine!

한국어 문서

Features

You can instantly start developing server programming with basic knowledge of JavaScript.
You can use all the APIs of Node.js.
You can use hundreds of npm modules out-of-box.
ECMAScript 6 support. (with Babel)
You can use COMMON and NODE of UJS.
Pages change instantly once you modify .nsp pages.
Built-in support for multi-core CPUs.

Install

Copy NSP.js, import folder and config.json to wherever you want.
Modify config.json.

{
    "port": 8123,
    "isDevMode": true,
    "rootPath": "./",
    "uploadURI": ["examples/upload_result.nsp"],
    "restURI": ["examples/restful"],
    "isNotUsingDCBN" : false,
    "isNotUsingCPUClustering" : false
}

port is the port of the web server.
isDevMode true means development mode. In development mode, resources such as images are not cached.
rootPath specified the root path where .nsp files or resources are saved.
uploadURI points to the URI to upload to.
restURI specifies the root URI of REST URI.
isNotUsingDCBN if set to true, {{, }} (double curly braces notation) is not allowed.

isNotUsingCPUClustering if set to true, multi-core is disabled; instead, NSP is run with single-core.

Running NSP server

node NSP-server.js

Now type http://localhost:8123, http://localhost:8123/index.nsp or http://localhost:8123/index in your browser. It's okay to omit .nsp.

Examples

<!DOCTYPE html>
<html>
    <body>
        <h1>My first NSP page</h1>
        <%
            var msg = 'Hello World!';
        %>
        <p>{{msg}}</p>
    </body>
</html>

Syntax

`<%`, `%>`

Allows server-side JavaScript codes to be embedded.

`{{`, `}}`, `<%=`, `%>`

Prints formatted expressions, e.g., {{expression}} or <%=expression %>. It is equivalent to <% print(expression); %>.

`<? expression>`, `</?>`, `<? else>`

Interprets statements only if expression is true. Otherwise, else is interpreted.

<%
    var a = true, b = false;
%>
<? a>
    I'm printed.
</?>
<? b>
    I'm not printed.
</?>
<? else>
    I'm printed.
</?>

`<~ array -> value>`, `</~>`

Iterates over an array.

<%
    var arr = [1, 2];
%>
<~ arr -> v>
    {{v}}
</~>

`<~ data -> value>`, `<~ data -> name: value>`, `</~>`

Iterates over an object.

<%
    var data = {
        a : 1,
        b : 2
    };
%>
<~ data -> n: v>
    {{n}} : {{v}}
</~>

`<~ number -> i>`, `</~>`

<~ 5 -> i>
    {{i}}
</~>

Built-in functions

print

Add contents to the HTML document using print function.

<!DOCTYPE html>
<html>
    <body>
        <h1>My first NSP page</h1>
        <%
            print('Hello World!');
        %>
    </body>
</html>

Output

<!DOCTYPE html>
<html>
    <body>
        <h1>My first NSP page</h1>
        Hello World!
    </body>
</html>

You can also print out JSON objects to make JSON-based APIs.

<%
    var data = {
        a : 1,
        b : 2,
        c : 3
    };

    print(data); // or {{data}}
%>

Output

{"a":1,"b":2,"c":3}

include

You can have another .nsp file in the page using include function.

If a variable was registered using var keyword, it is only visible in current page.
If a variable is used in multiple pages with include, you can use it by assigning values to self that are shared between pages in current request.

include.nsp

<!DOCTYPE html>
<html>
    <body>
        <% include('include/top.nsp'); %>
        <h1>My first NSP page</h1>
        <% include('include/bottom.nsp'); %>
    </body>
</html>

include/top.nsp

<%
    var local = 'Welcome!';

    self.msg = 'Hello World! ' + local;
%>

include/bottom.nsp

<p>{{self.msg}}</p>

If you give another function as the second argument of include function, you can set the action to be run after the inclusion finishes. Note that the inclusion doesn't start until the sentences that contain include function ends.

<!DOCTYPE html>
<html>
    <body>
        <%
            include('include/top.nsp', function() {
                console.log(self.msg); // Hello World! Welcome!
            });

            console.log(self.msg); // undefined
        %>
        <%
            console.log(self.msg); // Hello World! Welcome!
        %>
    </body>
</html>

You can also contain .js file to reuse one .js file for both server-side and client-side.

<!DOCTYPE html>
<html>
    <body>
        <% include('include/common.js'); %>
        <script src="include/common.js"></script>
    </body>
</html>

save/load

Saves or loads a variable. Loaded/saved variables are shared everywhere in the NSP server.

<%
    save('sample', 'this is an example.');
    load('sample'); // this is an example.
    save('sample', undefined); // Saving 'undefined' deletes the variable.
%>

pause/resume

Document processing is paused for a while in callbacks with pause function when you deal with database, etc.

start
<%
    setTimeout(function() {

        print('ok');

        resume();
    }, 1000);

    pause();
%>
end

cookie

Saves or loads a cookie.

<%
    // Saves a cookie
    cookie('sample-cookie', 'this is example.');
    cookie('sample-cookie', '', 0); // Removes a cookie
    cookie('sample-cookie', 'this is example.', 10); // Expired in 10 seconds
    cookie('sample-cookie', 'this is example.', 10, '/'); // Sets path to '/'
    cookie('sample-cookie', 'this is example.', 10, '/', 'www.example'); // Sets domain to www.example

    // Loads a cookie
    cookie('sample-cookie');
%>

Sessions example using `cookie`

An example to implement sessions using cookie and save/load.

<%
    var sessionKey = cookie('session-key');

    print(sessionKey);

    if (sessionKey === undefined) {
        sessionKey = RANDOM_STR(20);
    }

    cookie('session-key', sessionKey, 3600);
%>
<p>{{load(sessionKey)}}</p>
<%
    save(sessionKey, {
        name : 'YJ Sim',
        age : 28
    });
%>

The next step could be saving sessions to a file or a database.

upload

Uploads a file to the URI that's specified by uploadURI in config.json.

<%
    var paramsList;

    // Uploaded file is saved in 'upload_temp_files' folder.
    upload('upload_temp_files', function(_paramsList) {
        paramsList = _paramsList;
        resume();
    });

    pause();
%>
<~ paramsList -> params>
    <p>{{params}}</p>
</~>

redirect

Redirects the user to the URL specified.

<%
    redirect('/main.nsp');
%>

<%
    redirect('https://github.com/Hanul/NSP');
%>

escape

A statement with backslash(\) in front of <% or {{ is NOT interpreted. However, since two backslashes(\\) in front of <% or {{ is recognized as a backslash, that statement is interpreted.

<!DOCTYPE html>
<html>
    <body>
        <h1>My first NSP page</h1>

        \<%
            // This statement is NOT interpreted.
            var msg = 'Hello World!';
        %>
        \{{msg}}

        \\<%
            // This statement is interpreted.
            var msg = 'Hello World!';
        %>
        \\{{msg}}
    </body>
</html>

Built-in Variables

self.headers

Holds requested HTTP headers.

self.method

Holds requested HTTP Method. ex) GET, POST

self.ip

Holds requested IP address in String form. ex) 127.0.0.1

self.params

Holds data passed from forms, etc.

params.nsp

<!DOCTYPE html>
<html>
    <body>
        <h1>Params Example</h1>
        <form action="params_result.nsp" method="POST">
            First name: <input type="text" name="fname"><br>
            Last name: <input type="text" name="lname"><br>
            <input type="submit" value="Submit">
        </form>
    </body>
</html>

params_result.nsp

<!DOCTYPE html>
<html>
    <body>
        <h1>Params Example</h1>
        <p>
            {{self.params}}
        </p>
        <a href="params.nsp">Back</a>
    </body>
</html>

If you passed Sam as fname and Ple as lname, self.params should be {"fname":"Sam","lname":"Ple"}.

self.subURI

Holds requested sub URI, which is resulted by excluding restURI from the request full URI. If restURI is sample and the request URI is sample/1/edit, self.subURI holds 1/edit.

Samples

RESTful - https://github.com/Hanul/nsp-sample-restful
BBS (+ MongoDB) - https://github.com/Hanul/nsp-sample-bbs
BBS (+ MySQL) - https://github.com/Hanul/nsp-sample-bbs-mysql
BBS (+ AngularJS) - https://github.com/Hanul/nsp-sample-bbs-angularjs

Etc.

Are you familiar with PHP?

Install php.js and use it together with NSP.

<!DOCTYPE html>
<html>
    <body>
        <h1>NSP + php.js</h1>
        <%
            var php = require('phpjs');

            print(php.sprintf('Hey, %s : )', 'you'));
            print(php.parse_url('mysql://kevin:abcd1234@example.com/databasename')['pass']);
            print(php.strtotime('2 januari 2012, 11:12:13 GMT'));
        %>
    </body>
</html>

License

MIT

Author

Young Jae Sim

Node Server Pages

Server-side script to create dynamic web pages based on Node.js

Node Server Pages

Features

Install

Running NSP server

Examples

Syntax

<%, %>

{{, }}, <%=, %>

<? expression>, </?>, <? else>

<~ array -> value>, </~>

<~ data -> value>, <~ data -> name: value>, </~>

<~ number -> i>, </~>

Built-in functions

print

include

save/load

pause/resume

cookie

Sessions example using cookie

upload

redirect

escape

Built-in Variables

self.headers

self.method

self.ip

self.params

self.subURI

Samples

Etc.

Are you familiar with PHP?

License

Author

`<%`, `%>`

`{{`, `}}`, `<%=`, `%>`

`<? expression>`, `</?>`, `<? else>`

`<~ array -> value>`, `</~>`

`<~ data -> value>`, `<~ data -> name: value>`, `</~>`

`<~ number -> i>`, `</~>`

Sessions example using `cookie`