added expressjs error handler/native npm package

AndiDittrich · AndiDittrich · commit 019dcc81afe1 · 2017-05-15T07:45:35.000Z
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@
 .buildpath
 .git
 gfx/*
+node_modules*
 PublicHtml/*
diff --git a/README.md b/README.md
@@ -60,6 +60,40 @@ location /ErrorPages/ {
 }
 ```
 
+## expressjs Integration ##
+
+HttpErrorPages are available as NPM-Package - just install `http-error-pages` via **npm/yarn**
+
+```terminal
+npm install http-error-pages --save
+```
+
+Example
+
+```js
+var _express = require('express');
+var _webapp = _express();
+var _httpErrorPages = require('http-error-pages');
+
+// demo handler
+_webapp.get('/', function(req, res){
+    res.type('.txt').send('HttpErrorPages Demo');
+});
+
+// throw an 403 error
+_webapp.get('/my403error', function(req, res, next){
+    var myError = new Error();
+    myError.status = 403;
+    next(myError);
+});
+
+// use http error pages handler (final statement!)
+_httpErrorPages(_webapp);
+
+// start service
+_webapp.listen(8888);
+```
+
 ## Apache Httpd Integration ##
 [Apache Httpd 2.x](http://httpd.apache.org/) supports custom error-pages using multiple [ErrorDocument](http://httpd.apache.org/docs/2.4/mod/core.html#errordocument) directives.
 
diff --git a/dist/HTTP0.html b/dist/HTTP0.html
@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <!-- Simple HttpErrorPages | MIT X11 License | https://github.com/AndiDittrich/HttpErrorPages -->
+
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    
+    <title>We've got some trouble | {{code}} - {{title}}</title>
+
+    <style type="text/css">/*! normalize.css v5.0.0 | MIT License | github.com/necolas/normalize.css */html{font-family:sans-serif;line-height:1.15;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,footer,header,nav,section{display:block}h1{font-size:2em;margin:.67em 0}figcaption,figure,main{display:block}figure{margin:1em 40px}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent;-webkit-text-decoration-skip:objects}a:active,a:hover{outline-width:0}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:inherit}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}dfn{font-style:italic}mark{background-color:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}audio,video{display:inline-block}audio:not([controls]){display:none;height:0}img{border-style:none}svg:not(:root){overflow:hidden}button,input,optgroup,select,textarea{font-family:sans-serif;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type=reset],[type=submit],button,html [type=button]{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{display:inline-block;vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-cancel-button,[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details,menu{display:block}summary{display:list-item}canvas{display:inline-block}template{display:none}[hidden]{display:none}/*! Simple HttpErrorPages | MIT X11 License | https://github.com/AndiDittrich/HttpErrorPages */body,html{width:100%;height:100%;background-color:#21232a}body{color:#fff;text-align:center;text-shadow:0 2px 4px rgba(0,0,0,.5);padding:0;min-height:100%;-webkit-box-shadow:inset 0 0 75pt rgba(0,0,0,.8);box-shadow:inset 0 0 75pt rgba(0,0,0,.8);display:table;font-family:"Open Sans",Arial,sans-serif}h1{font-family:inherit;font-weight:500;line-height:1.1;color:inherit;font-size:36px}h1 small{font-size:68%;font-weight:400;line-height:1;color:#777}a{text-decoration:none;color:#fff;font-size:inherit;border-bottom:dotted 1px #707070}.lead{color:silver;font-size:21px;line-height:1.4}.cover{display:table-cell;vertical-align:middle;padding:0 20px}footer{position:fixed;width:100%;height:40px;left:0;bottom:0;color:#a0a0a0;font-size:14px}</style>
+</head>
+
+<body>
+    <div class="cover">
+        <h1>{{title}} <small>Error {{code}}</small></h1>
+        <p class="lead">{{message}}</p>
+    </div>
+    
+    </body>
+</html>
diff --git a/dist/HTTP400.html b/dist/HTTP400.html
@@ -18,6 +18,5 @@ <h1>Bad Request <small>Error 400</small></h1>
         <p class="lead">The server cannot process the request due to something that is perceived to be a client error.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/HTTP401.html b/dist/HTTP401.html
@@ -18,6 +18,5 @@ <h1>Unauthorized <small>Error 401</small></h1>
         <p class="lead">The requested resource requires an authentication.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/HTTP403.html b/dist/HTTP403.html
@@ -18,6 +18,5 @@ <h1>Access Denied <small>Error 403</small></h1>
         <p class="lead">The requested resource requires an authentication.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/HTTP404.html b/dist/HTTP404.html
@@ -18,6 +18,5 @@ <h1>Resource not found <small>Error 404</small></h1>
         <p class="lead">The requested resource could not be found but may be available again in the future.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/HTTP500.html b/dist/HTTP500.html
@@ -19,6 +19,5 @@ <h1>Webservice currently unavailable <small>Error 500</small></h1>
 Our service team has been dispatched to bring it back online.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/HTTP501.html b/dist/HTTP501.html
@@ -18,6 +18,5 @@ <h1>Not Implemented <small>Error 501</small></h1>
         <p class="lead">The Webserver cannot recognize the request method.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/HTTP502.html b/dist/HTTP502.html
@@ -19,6 +19,5 @@ <h1>Webservice currently unavailable <small>Error 502</small></h1>
 Our service team has been dispatched to bring it back online.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/HTTP503.html b/dist/HTTP503.html
@@ -19,6 +19,5 @@ <h1>Webservice currently unavailable <small>Error 503</small></h1>
 Our service team has been dispatched to bring it back online.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/HTTP520.html b/dist/HTTP520.html
@@ -18,6 +18,5 @@ <h1>Origin Error - Unknown Host <small>Error 520</small></h1>
         <p class="lead">The requested hostname is not routed. Use only hostnames to access resources.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/HTTP521.html b/dist/HTTP521.html
@@ -19,6 +19,5 @@ <h1>Webservice currently unavailable <small>Error 521</small></h1>
 Our service team has been dispatched to bring it back online.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/HTTP533.html b/dist/HTTP533.html
@@ -19,6 +19,5 @@ <h1>Scheduled Maintenance <small>Error 533</small></h1>
 Our service team is working hard to bring it back online soon.</p>
     </div>
     
-        
-</body>
+    </body>
 </html>
diff --git a/dist/pages.tar b/dist/pages.tar
diff --git a/dist/pages.zip b/dist/pages.zip
diff --git a/express-demo.js b/express-demo.js
@@ -0,0 +1,22 @@
+var _express = require('express');
+var _webapp = _express();
+var _httpErrorPages = require('./lib/error-handler');
+
+// demo handler
+_webapp.get('/', function(req, res){
+    res.type('.txt').send('HttpErrorPages Demo');
+});
+
+// throw an 403 error
+_webapp.get('/my403error', function(req, res, next){
+    var myError = new Error();
+    myError.status = 403;
+    next(myError);
+});
+
+// use http error pages handler (final statement!)
+_httpErrorPages(_webapp);
+
+// start service
+_webapp.listen(8888);
+console.log('Running Demo on Port 8888');
diff --git a/generator.php b/generator.php
@@ -30,12 +30,19 @@
 // load inline css
 $css = trim(file_get_contents('assets/Layout.css'));
 
+// js template page
+$pages['{{code}}'] = array(
+    'title' => '{{title}}',
+    'message' => '{{message}}',
+    'footer' => '{{footer}}'
+);
+
 // generate each error page
 foreach ($pages as $code => $page){
     echo 'Generating Page ', $page['title'], ' (', $code, ')..', PHP_EOL;
 
     // assign variables
-    $v_code = intval($code);
+    $v_code = $code;
     $v_title = nl2br(htmlspecialchars($page['title']));
     $v_message = nl2br(htmlspecialchars($page['message']));
     $v_footer = (isset($config['footer']) ? $config['footer'] : '');
diff --git a/lib/dispatcher.js b/lib/dispatcher.js
@@ -0,0 +1,47 @@
+var _pages = require('../dist/pages.json');
+var _renderer = require('./page-renderer');
+
+// multi-type support
+// @see https://github.com/expressjs/express/blob/master/examples/error-pages/index.js
+function dispatchRequest(page, httpStatusCode, req, res){
+    // page available ?
+    if (!_pages[page]){
+        // use "internal server error" as default
+        page = '500';
+        httpStatusCode = null;
+    }
+
+    // set http status code
+    res.status(httpStatusCode || 500);
+
+    // extract page date
+    var pageData = _pages[page];
+
+    // multiple response formats
+    res.format({
+        // standard http-error-pages
+        html: function(){
+            res.type('.html');
+            res.send(_renderer({
+                code: httpStatusCode,
+                title: pageData.title,
+                message: pageData.message
+            }))
+        },
+
+        // json
+        json: function(){
+            res.json({
+                error: pageData.title + ' - ' + pageData.message
+            })
+        },
+
+        // text response
+        default: function(){
+            // plain text
+            res.type('.txt').send(pageData.title + ' - ' + pageData.message);
+        }
+    })
+}
+
+module.exports = dispatchRequest;
diff --git a/lib/error-handler.js b/lib/error-handler.js
@@ -0,0 +1,27 @@
+var _dispatcher = require('./dispatcher');
+
+// http404 handler
+function notfoundHandler(req, res){
+    _dispatcher('404', 404, req, res);
+}
+
+// default error handler
+function errorHandler(err, req, res, next){
+    // status code given ?
+    if (err.status){
+        // custom errorpage set ?
+        _dispatcher(err.errorpage || err.status, err.status, req, res);
+
+    // use default http500 page
+    }else{
+        _dispatcher('500', 500, req, res);
+    }
+};
+
+module.exports = function(router){
+    // 404
+    router.use(notfoundHandler);
+
+    // internal errors (all)
+    router.use(errorHandler);
+};
diff --git a/lib/page-renderer.js b/lib/page-renderer.js
@@ -0,0 +1,27 @@
+var _path = require('path');
+var _fs = require('fs');
+var _basedir = _path.dirname(__dirname);
+
+// load template file (1 time)
+var _template = _fs.readFileSync(_path.join(_basedir, 'dist/HTTP0.html'), 'utf8');
+
+// simple template renderer
+function renderPage(vars){
+    var tpl = _template;
+
+    // add vars
+    tpl = tpl.replace(/{{([a-z]+)}}/gm, function(match, name){
+
+        // var available ?
+        if (vars[name]){
+            return vars[name];
+        // remove unused vars
+        }else{
+            return '';
+        }
+    });
+
+    return tpl;
+}
+
+module.exports = renderPage;
diff --git a/package.json b/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "http-error-pages",
+  "version": "0.1.0",
+  "description": "Simple HTTP Error Pages for expressjs",
+  "keywords": [
+    "http",
+    "https",
+    "error",
+    "errorpage",
+    "express",
+    "expressjs",
+    "router",
+    "handler"
+  ],
+  "files": [
+    "bin",
+    "dist",
+    "express-demo.js",
+    "CHANGED.md",
+    "LICENSE.md",
+    "README.md"
+  ],
+  "bin": {},
+  "main": "./lib/router.js",
+  "author": "Andi Dittrich (https://andidittrich.de)",
+  "homepage": "https://github.com/AndiDittrich/HttpErrorPages",
+  "bugs": "https://github.com/AndiDittrich/HttpErrorPages/issues",
+  "repository": "AndiDittrich/HttpErrorPages",
+  "license": "MIT",
+  "devDependencies": {
+    "express": "^4.15.2"
+  }
+}
diff --git a/template.phtml b/template.phtml
@@ -22,6 +22,6 @@
     <footer>
         <p><?php echo $v_footer; ?></p>
     </footer>
-    <?php } ?>    
+    <?php } ?>
 </body>
 </html>
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
         <p class="lead">The server cannot process the request due to something that is perceived to be a client error.</p>
     </div>
+-
 -</body>
 +    </body>
 </html>