Deprecate some routes (#1199)

* Deprecate some routes

* Normalize on `/login`... keep `register` to ourselves in the code... we already do this a lot... think `index.js` vs `main`.
* Removed one dead route... why would we want to do `/github` to `/`... means to me that it's dead... just return a default 404.
* Fixed one doc send with status 302 to redirect instead... default is 302 ... would use a 307 but that's only HTTP/1.1 and would definitely rule out any older browser although may be reconsidered at a later date
* Some white space treatment

Applies to #1198 #135 and post #1174

* Undeprecate a route

* Added a note

Applies to #135

* Remove this route since it won't exist

Applies to #135

* Revert last commit

* Will exist for hook but root of it won't

Applies to #135

controllers/auth.js

@@ -94,7 +94,7 @@ exports.auth = function (aReq, aRes, aNext) {
  var strategy = aReq.body.auth || aReq.params.strategy;
  var username = aReq.body.username || aReq.session.username ||
  (authedUser ? authedUser.name : null);
- var authOpts = { failureRedirect: '/register?stratfail' };
+ var authOpts = { failureRedirect: '/login?stratfail' };
  var passportKey = aReq._passport.instance._key;
 
  // Yet another passport hack.
@@ -118,7 +118,7 @@ exports.auth = function (aReq, aRes, aNext) {
  }
 
  if (!username) {
- aRes.redirect('/register?noname');
+ aRes.redirect('/login?noname');
  return;
  }
  // Clean the username of leading and trailing whitespace,
@@ -127,7 +127,7 @@ exports.auth = function (aReq, aRes, aNext) {
 
  // The username could be empty after the replacements
  if (!username) {
- aRes.redirect('/register?noname');
+ aRes.redirect('/login?noname');
  return;
  }
 
@@ -164,7 +164,7 @@ exports.auth = function (aReq, aRes, aNext) {
  }
 
  if (!strategy) {
- aRes.redirect('/register');
+ aRes.redirect('/login');
  return;
  } else {
  auth();
@@ -243,7 +243,7 @@ exports.callback = function (aReq, aRes, aNext) {
  console.error(colors.red('`User` not found'));
  }
 
- aRes.redirect(doneUri + (doneUri === '/' ? 'register' : '') + '?authfail');
+ aRes.redirect(doneUri + (doneUri === '/' ? 'login' : '') + '?authfail');
  return;
  }
 
@@ -296,8 +296,7 @@ exports.callback = function (aReq, aRes, aNext) {
 
 exports.validateUser = function validateUser(aReq, aRes, aNext) {
  if (!aReq.session.user) {
- aRes.location('/login');
- aRes.status(302).send();
+ aRes.redirect('/login');
  return;
  }
  aNext();

controllers/index.js

@@ -243,7 +243,7 @@ exports.register = function (aReq, aRes) {
  options.redirectTo = getRedirect(aReq);
 
  // Page metadata
- pageMetadata(options, 'Register');
+ pageMetadata(options, 'Login');
 
  // Session
  options.authedUser = authedUser = modelParser.parseUser(authedUser);

routes.js

@@ -31,7 +31,9 @@ module.exports = function (aApp) {
  aApp.route('/auth/:strategy').get(authentication.auth);
  aApp.route('/auth/:strategy/callback/:junk?').get(authentication.callback);
  aApp.route('/login').get(main.register);
- aApp.route('/register').get(main.register);
+ aApp.route('/register').get(function (aReq, aRes) {
+ aRes.redirect(301, '/login');
+ });
  aApp.route('/logout').get(main.logout);
 
  // User routes
@@ -44,8 +46,11 @@ module.exports = function (aApp) {
  aApp.route('/users/:username/github/import').post(authentication.validateUser, user.userGitHubImportScriptPage);
  aApp.route('/users/:username/profile/edit').get(authentication.validateUser, user.userEditProfilePage).post(authentication.validateUser, user.update);
  aApp.route('/users/:username/update').post(admin.adminUserUpdate);
+ // NOTE: Some below inconsistent with priors
  aApp.route('/user/preferences').get(authentication.validateUser, user.userEditPreferencesPage);
- aApp.route('/user').get(function (aReq, aRes) { aRes.redirect('/users'); });
+ aApp.route('/user').get(function (aReq, aRes) {
+ aRes.redirect(302, '/users');
+ });
  aApp.route('/api/user/exist/:username').head(user.exist);
 
  // Adding script/library routes
@@ -55,14 +60,16 @@ module.exports = function (aApp) {
  aApp.route('/user/add/lib').get(authentication.validateUser, user.newLibraryPage);
  aApp.route('/user/add/lib/new').get(script.new(script.lib(user.editScript))).post(authentication.validateUser, script.new(script.lib(user.submitSource)));
  aApp.route('/user/add/lib/upload').post(authentication.validateUser, script.lib(user.uploadScript));
- aApp.route('/user/add').get(function (aReq, aRes) { aRes.redirect('/user/add/scripts'); });
+ aApp.route('/user/add').get(function (aReq, aRes) {
+ aRes.redirect(301, '/user/add/scripts');
+ });
 
  // Script routes
  aApp.route('/scripts/:username/:scriptname').get(script.view);
  aApp.route('/scripts/:username/:scriptname/edit').get(authentication.validateUser, script.edit).post(authentication.validateUser, script.edit);
  aApp.route('/scripts/:username/:scriptname/source').get(user.editScript);
  aApp.route('/scripts/:username').get(function (aReq, aRes) {
- aRes.redirect('/users/' + aReq.params.username + '/scripts'); // NOTE: Watchpoint
+ aRes.redirect(301, '/users/' + aReq.params.username + '/scripts'); // NOTE: Watchpoint
  });
 
  aApp.route('/install/:username/:scriptname').get(scriptStorage.unlockScript, scriptStorage.sendScript);
@@ -72,7 +79,6 @@ module.exports = function (aApp) {
  // Github hook routes
  aApp.route('/github/hook').post(scriptStorage.webhook);
  aApp.route('/github/service').post(function (aReq, aRes, aNext) { aNext(); });
- aApp.route('/github').get(function (aReq, aRes) { aRes.redirect('/'); });
 
  // Library routes
  aApp.route('/libs/:username/:scriptname').get(script.lib(script.view));

views/includes/header.html

@@ -23,7 +23,7 @@
  <li><a href="/logout" title="Sign Out"><span class="visible-xs-inline">Sign Out</span><i class="fa fa-sign-out"></i></a></li>
  {{/authedUser}}
  {{^authedUser}}
- <li><a href="/register">Sign In / Sign Up <i class="fa fa-sign-in"></i></a></li>
+ <li><a href="/login">Sign In / Sign Up <i class="fa fa-sign-in"></i></a></li>
  {{/authedUser}}
  </ul>
  </div>

views/pages/loginPage.html

@@ -11,12 +11,12 @@
  <form action="/auth/" method="post" class="form-register">
  <input type="hidden" name="redirectTo" value="{{{redirectTo}}" />
  <h3>
- Register
+ Login
  <span class="help-block small">Enter your username for our site to use with your preferred <a href="https://www.wikipedia.org/wiki/OAuth">OAuth</a>/<a href="https://www.wikipedia.org/wiki/OpenID">OpenID</a> service.</span>
  </h3>
  <noscript>
  <div class="alert alert-danger small" role="alert">
- <i class="fa fa-exclamation-triangle"></i> <strong>WARNING</strong>: The username entered may include additional sanitizing for web friendly URLs and Userscript engine compatibility. If you wish to see the sanitization changes please enable JavaScript and <a href="/register">start over</a>.
+ <i class="fa fa-exclamation-triangle"></i> <strong>WARNING</strong>: The username entered may include additional sanitizing for web friendly URLs and Userscript engine compatibility. If you wish to see the sanitization changes please enable JavaScript and <a href="/login">start over</a>.
  </div>
  </noscript>
  <div class="input-group">
@@ -32,7 +32,7 @@ <h3>
  </span>
  </div>
  <div class="alert alert-warning small" role="alert">
- <i class="fa fa-exclamation-triangle"></i> <strong>CAUTION</strong>: The username that you choose to register will be displayed to everyone. It is strongly recommended to <strong>not</strong> attempt to use an email address.
+ <i class="fa fa-exclamation-triangle"></i> <strong>CAUTION</strong>: The username that you choose to login with will be displayed to everyone. It is strongly recommended to <strong>not</strong> attempt to use an email address.
  </div>
  <ul class="nav nav-pills nav-justified">
  <li><a href="/about/Privacy-Policy"><i class="fa fa-user-secret"></i> Privacy Policy</a></li>