Merge pull request #271 from CPSSD/a/user-option-items-per-page#167

Add items per page options

Author: m1cr0man

doc/db/user.md

@@ -2,26 +2,48 @@ User Database Specifications
 ===========================
 
 The user database is the database that holds data individual to each user,
-including authentification data.
-
-It interfaces with the secretary, and is used in combination with the Feed
+including authentication data  and is used in combination with the Feed
 Database to create entries in the finished G2G database.
 
 The user password will not be stored, instead, a salt and the hashed password
 and salt will be stored. These are stored in the same string in bcrypt.
 
+Tokens
+-------
+
 Tokens represents the randomly generated API tokens. Currently they point to a
 true value but this could be modified such that each token had validation date
 and permissions.
 
+Models
+-------
+
 The `model` field holds a pickled scikit-learn `SGDClassifier`, ie. the
 classification model of that user. It is compiled from the data in the other
 fields, and is updated by the `update-user-model` Gearman worker.
 
+Verification
+-------
+
 When the user initially signs up, `verified` will be a token used to
 verify the address from the link in the email. It will be set to `true`
 permanently after verification.
 
+Config
+------
+
+Users have a set of default behaviour that they can set and these are stored
+in the `defaults` key.
+
+#### Current Defaults:
+
+```
+{
+	 // this refers to the default pagination size
+	"page_length": int
+}
+```
+
 Example Document
 ----------------
 
@@ -35,6 +57,7 @@ Example Document
 	"password": "$2a$08$ThzPc3zm84JPb6LmvcfCkuXkwyh8H.Mn1VC4EKu9guksI9lbdb7Fa",
 	"subscribed_feeds": ["news.ycombinator.com/rss", "pssd.computing.dcu.ie/rss.xml"],
 	"words": {"butter":2, "milk":13, "antidisestablishmentarianism":-33},
+	"defaults": {"page_length": 20}
 	"tokens": {"add15f620657bb3fd8ce7fa9611f1aaba8717559295706a6d80f9e8cf58e81d7":true},
 	"model": "ccopy_reg\n_reconstructor\np0\n(csklearn.linear_model.stochastic_gradient\nSGDClassifier\np1\nc__builtin__\nobject\np2\nNtp3\nRp4\n(dp5\nS't_'\np6\ncnumpy.core.multiarray\nscalar\np7\n(cnumpy\ndtype\np8\n(S'f8'\np9\nI0\nI1\ntp10\nRp11\n(I3\nS'<'\np12\nNNNI-1\nI-1\nI0\ntp13\nbS'\\x00\\x00\\x00\\x00\\x00\\x98\\x8f@'\np14\ntp15\nRp16\nsS'n_jobs'\np17\nI1\nsS'shuffle'\np18\nI00\nsS'verbose'\np19\nI0\nsS'classes_'\np20\ncnumpy.core.multiarray\n_reconstruct\np21\n(cnumpy\nndarray\np22\n(I0\ntp23\nS'b'\np24\ntp25\nRp26\n(I1\n(I2\ntp27\ng8\n(S'i8'\np28\nI0\nI1\ntp29\nRp30\n(I3\nS'<'\np31\nNNNI-1\nI-1\nI0\ntp32\nbI00\nS'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x01\\x00\\x00\\x00\\x00\\x00\\x00\\x00'\np33\ntp34\nbsS'class_weight'\np35\nNsS'fit_intercept'\np36\nI01\nsS'penalty'\np37\nS'l2'\np38\nsS'random_state'\np39\nNsS'loss_function'\np40\ncsklearn.linear_model.sgd_fast\nLog\np41\n(tRp42\nsS'C'\np43\nF1.0\nsS'n_iter'\np44\nI5\nsS'epsilon'\np45\nF0.1\nsS'learning_rate'\np46\nS'optimal'\np47\nsS'coef_'\np48\ng21\n(g22\n(I0\ntp49\ng24\ntp50\nRp51\n(I1\n(I1\nI2\ntp52\ng8\n(S'f8'\np53\nI0\nI1\ntp54\nRp55\n(I3\nS'<'\np56\nNNNI-1\nI-1\nI0\ntp57\nbI00\nS\"\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\xdd}'\\xb4\\x00\\x94\\xd3\\xc2\"\np58\ntp59\nbsS'alpha'\np60\nF0.0001\nsS'intercept_'\np61\ng21\n(g22\n(I0\ntp62\ng24\ntp63\nRp64\n(I1\n(I1\ntp65\ng11\nI00\nS'\\x00\\x00\\x00\\x00\\x00\\x00\\x14\\xc0'\np66\ntp67\nbsS'_expanded_class_weight'\np68\ng21\n(g22\n(I0\ntp69\ng24\ntp70\nRp71\n(I1\n(I2\ntp72\ng11\nI00\nS'\\x00\\x00\\x00\\x00\\x00\\x00\\xf0?\\x00\\x00\\x00\\x00\\x00\\x00\\xf0?'\np73\ntp74\nbsS'warm_start'\np75\nI00\nsS'loss'\np76\nS'log'\np77\nsS'eta0'\np78\nF0.0\nsS'l1_ratio'\np79\nF0.15\nsS'power_t'\np80\nF0.5\nsb."
 }

server/controllers/bookmarks.js

@@ -27,7 +27,7 @@ module.exports = {
 
     bookmarkModel.getBookmarks(req.session.username, bookmarks => {
       if (!bookmarks){
-        bookmarks = []
+        bookmarks = [];
       }
       // Filter the bookmarks
       var filtered_bookmarks = bookmarks.filter((feed, index, src) => {

server/controllers/streams.js

@@ -6,20 +6,21 @@
  */
 
 const getFeeds = require("../models/stream").getFeeds;
+const user = require("../controllers/users");
+const userModel = require("../models/user");
 const _ = require("lodash");
 
 // Stream listing
 module.exports = {
   index: (req, res) => {
 
-    // Get & verify the page length & number
     // This Lo-Dash function is lovely
     var page_length = _.toSafeInteger(req.query.page_length);
     if (page_length <= 0) {
-      page_length = 20; // Default Page Length = 20
+      page_length = req.session.page_length; // Use the user's default instead
     }
-    var page = _.toSafeInteger(req.query.page); // defaults to 0 if undefined
 
+    var page = _.toSafeInteger(req.query.page); // defaults to 0 if undefined
     // Sort out the filters
     var keywords = [];
     if (typeof req.query.keywords != "undefined" && req.query.keywords.length > 1) {
@@ -30,7 +31,6 @@ module.exports = {
 
       // Filter the feeds
       var filtered_feeds = feeds.filter((feed, index, src) => {
-
         // Match with the filters
         return (typeof req.query.source == "undefined" || req.query.source.length < 1 || feed.feed == req.query.source) &&
                (keywords.length < 1 || keywords.every(val => feed.name.toLowerCase().includes(val)));
@@ -55,21 +55,21 @@ module.exports = {
         source: req.query.source || ""
       });
     });
+
   },
 
   plaintext: (req, res) => {
+    res.type('.txt');
+
+    // This Lo-Dash function is lovely
     var page_length = _.toSafeInteger(req.query.page_length);
     if (page_length <= 0) {
-      page_length = 20; // Default Page Length = 20
+      page_length = req.session.page_length; // Use the user's default instead
     }
-    var page = _.toSafeInteger(req.query.page);
-
 
+    var page = _.toSafeInteger(req.query.page);
     var username = req.query.username;
-    res.type('.txt');
-
     getFeeds(username, feeds => {
-
       var pageinated_feeds = _.slice(feeds, page*page_length, (page+1)*page_length);
       var next_page = page + 1;
       if ((page + 1) * page_length > feeds.length) next_page = 0;
@@ -81,5 +81,6 @@ module.exports = {
         page_length: page_length
       });
     });
+
   }
 };

server/controllers/users.js

@@ -98,6 +98,7 @@ module.exports = {
 
           // Set session vars and redirect
           req.session.username = user.username;
+          req.session.page_length = user.page_length || userModel.defaultPageLength;
           req.session.subscribed_feeds = user.subscribed_feeds;
           req.session.verified = user.verified;
           req.session.msg = "Successfully logged in.";
@@ -198,6 +199,29 @@ module.exports = {
     });
   },
 
+  changePageLength: (req, res) => {
+    var username = req.session.username;
+    var page_length = _.toSafeInteger(req.body.page_length);
+
+    if (!(page_length == 5 || page_length == 10 || page_length == 20 || page_length == 50)) {
+      req.session.msg = "Invalid page length";
+      return res.redirect(302, "/user");
+    }
+
+    userModel.findByUsername(username, user => {
+      if (typeof user == "undefined") {
+        req.session.msg = "Invalid username";
+        return res.redirect(302, "/user");
+      }
+
+      userModel.setPageLength(username, page_length, _ => {
+        req.session.msg = "Successfully changed your defaults";
+        req.session.page_length = page_length;
+        return res.redirect(302, "/user");
+      });
+    });
+  },
+
   // Allow for password change
   changePassword: (req, res) => {
 
@@ -251,7 +275,6 @@ module.exports = {
     // Load request vars & verify
     var username = req.session.username;
     var newEmail = req.body.newEmail;
-    var oldEmail = req.body.oldEmail;
 
     // Check validity of passwords
     if (newEmail.length < 5){
@@ -271,10 +294,7 @@ module.exports = {
         req.session.msg = "Invalid username.";
         return res.redirect(302, "/user");
       }
-      if (user.email != oldEmail) {
-        req.session.msg = "Incorrect current email.";
-        return res.redirect(302, "/user");
-      }
+
       crypto.randomBytes(32, (err, buf) => {
         if (err) return res.status(500).render("signup", {err: "Failed to generate verification token:" + err, captcha: captcha_html});
         var token = buf.toString("hex");

server/middleware/db.js

@@ -69,6 +69,15 @@ module.exports = {
 
       if (err) throw err;
 
+      return cb();
+    });
+  },
+
+  upsert: (db, collection, selector, cb) => {
+    db.collection(collection).upsert(selector, {$set: data}, (err, data) => {
+
+      if (err) throw err;
+
       return cb();
     });
   }

server/middleware/gearman.js

@@ -37,7 +37,7 @@ module.exports = {
     }
     client.connect( () => {
       if ('SECRETKEY' in process.env) {
-        job_data['key'] = process.env['SECRETKEY'];
+        job_data.key = process.env.SECRETKEY;
       }
       var bson_data = BSON.serialize(job_data, false, true, false);
       client.submitJob( job_name, data=bson_data , options=job_options);

server/middleware/routes.js

@@ -24,113 +24,101 @@ function isAuthed(req, res, next) {
   }
 }
 
-// User pages
+// Stream & Landing page
+router.get("/", (req, res, next) => {
+  if (req.session.username) {
+    if (process.env.ENVIRONMENT == "PRODUCTION" && typeof req.session.verified != "boolean") {
+      res.redirect(302, "/user/verify");
+    } else {
+      res.locals.session = req.session;
+      next();
+    }
+  } else {
+    res.status(200).render('index');
+  }
+}, streamController.index);
 
-// Logout
-router.all("/user/logout", userController.logout);
 
-// Signup
-router.all("/user/signup", userController.signup);
+// ## /user
 
-// Login processing
+// ### Logout
+router.all("/user/logout", userController.logout);
+// ### Signup
+router.all("/user/signup", userController.signup);
+// ### Login processing
 router.post("/user/login", userController.login);
-
-// Login form
+// ### Login form
 router.get("/user/login", (req, res) => {
   // Go to profile if user is already logged in
   if (typeof req.session.username != "undefined") return res.redirect(302, "/user");
 
   res.render("login");
 });
-
-// Verification action
+// ### Verification action
 router.get("/user/verify/:token", userController.verify);
-
-// Verification asker
+// ### Verification asker
 router.get("/user/verify", (req, res) => {
   res.locals.session = req.session;
   res.render("verify_ask");
 });
-
 // Profile
 router.get("/user", isAuthed, userController.profile);
-
-// Summary sender
-router.get("/user/summaries/:key", userController.sendSummaries);
-
 // Profile tokens
 router.get("/user/tokens", isAuthed, userController.profileTokens);
-
 // Profile settings
 router.post("/user/change/password", isAuthed, userController.changePassword);
-
-// Profile settings
 router.post("/user/change/email", isAuthed, userController.changeEmail);
+router.post("/user/change/page-length", isAuthed, userController.changePageLength);
+// Summary sender
+router.get("/user/summaries/:key", userController.sendSummaries);
 
-// Profile settings
-router.post("/user/change/summaryinterval", isAuthed, userController.changeSummaryInterval);
+// ## /feeds
 
-// Show interest
+// ### Profile settings
+router.post("/user/change/summaryinterval", isAuthed, userController.changeSummaryInterval);
+// ### Show interest
 router.post("/feeds/like", isAuthed, feedController.like);
-
-// Show disinterest buttons
+// ### Show disinterest buttons
 router.post("/feeds/dislike", isAuthed, feedController.dislike);
-
-// Add
+// ### Add
 router.get("/feeds/add", isAuthed, (req, res) => { res.render("feeds_add"); });
-
-// Add processing
+// ### Add processing
 router.post("/feeds/add", isAuthed, feedController.add);
-
-// Remove processing
+// ### Remove processing
 router.get("/feeds/remove", isAuthed, feedController.remove);
-
-// List
+// ### List
 router.get("/feeds", isAuthed, feedController.index);
 
-// Stream & Landing page
-router.get("/", (req, res, next) => {
-  if (req.session.username) {
-    if (process.env.ENVIRONMENT == "PRODUCTION" && typeof req.session.verified != "boolean") {
-      res.redirect(302, "/user/verify");
-    } else {
-      res.locals.session = req.session;
-      next();
-    }
-  } else {
-    res.status(200).render('index');
-  }
-}, streamController.index);
+// ## /bookmarks
 
 // Display Bookmarks
 router.get("/bookmarks", isAuthed, bookmarkController.bookmarks);
-
 // Add Bookmark
 router.post("/bookmarks/add", isAuthed, bookmarkController.add);
-
 // Delete Bookmark
 router.post("/bookmarks/remove", isAuthed, bookmarkController.remove);
 
-// Tokens (for API stuff!)
+// ## /token
+
 router.get("/token/add", isAuthed, userController.addToken);
 router.get("/token/remove", isAuthed, userController.removeToken);
 router.get("/token/list", isAuthed, userController.listTokens);
 
-// Plaintext Endpoint
+// ## Plaintext Endpoint
 router.get("/plaintext", userController.validToken, streamController.plaintext);
 
-// Repo updater
+// ## Repo updater
 router.post("/pull/:token", updater.check, updater.run);
 
-// Routes for ToS and Privacy Policy
+// ## Routes for ToS and Privacy Policy
 router.get("/terms", (req, res) => {
   return res.status(200).render("terms_of_service");
 });
 router.get("/privacy", (req, res) => {
   return res.status(200).render("privacy_policy");
 });
 
-// 403 page
+// ## 403 page
 router.get("/forbidden", (req, res) => {
   res.locals.session = req.session;
   res.render("403");

server/models/bookmark.js

@@ -50,11 +50,11 @@ module.exports = {
   removeBookmark: (username, url, cb) => {
 
     dbFuncs.transaction(db => dbFuncs.findOne(db, "bookmark", {username: username}, user => {
-
+      var index;
       // Check if the user is already subscribed to this feed
       for (var i = 0; i <= user.bookmarks.length; i++) {
         if (user.bookmarks[i].link == url){
-          var index = i;
+          index = i;
           break;
         } else if (i == user.bookmarks.length -1){
           return cb();
@@ -82,7 +82,7 @@ module.exports = {
           bookmarks: []
         }, cb));
     } else {
-        cb(data.bookmarks)
+        cb(data.bookmarks);
     }
     }));
   }