From a08c50a77dc897009f9e40d9d0bdab0a219d59fa Mon Sep 17 00:00:00 2001
From: Luc Didry <luc@didry.org>
Date: Tue, 24 Feb 2015 23:42:35 +0100
Subject: [PATCH] Fixes #1870

Add two functions to API :
 * getSavedRevisionsCount
 * listSavedRevisions
---
 doc/api/http_api.md            | 20 +++++++++++++++++-
 src/node/db/API.js             | 38 ++++++++++++++++++++++++++++++++++
 src/node/db/Pad.js             | 12 +++++++++++
 src/node/handler/APIHandler.js |  2 ++
 4 files changed, 71 insertions(+), 1 deletion(-)

diff --git a/doc/api/http_api.md b/doc/api/http_api.md
index 84a4ec7e2..d6432e3cd 100644
--- a/doc/api/http_api.md
+++ b/doc/api/http_api.md
@@ -61,7 +61,7 @@ Portal submits content into new blog post
 ## Usage
 
 ### API version
-The latest version is `1.2.10`
+The latest version is `1.2.11`
 
 The current version can be queried via /api.
 
@@ -402,6 +402,24 @@ returns the number of revisions of this pad
   * `{code: 0, message:"ok", data: {revisions: 56}}`
   * `{code: 1, message:"padID does not exist", data: null}`
 
+#### getSavedRevisionsCount(padID)
+ * API >= 1.2.11
+
+returns the number of saved revisions of this pad
+
+*Example returns:*
+  * `{code: 0, message:"ok", data: {savedRevisions: 42}}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+#### listSavedRevisions(padID)
+ * API >= 1.2.11
+
+returns the list of saved revisions of this pad
+
+*Example returns:*
+  * `{code: 0, message:"ok", data: {savedRevisions: [2, 42, 1337]}}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
 #### padUsersCount(padID)
  * API >= 1
 
diff --git a/src/node/db/API.js b/src/node/db/API.js
index 81dedcfef..ab8a1d405 100644
--- a/src/node/db/API.js
+++ b/src/node/db/API.js
@@ -517,6 +517,44 @@ exports.getRevisionsCount = function(padID, callback)
   });
 }
 
+/**
+getSavedRevisionsCount(padID) returns the number of saved revisions of this pad
+
+Example returns:
+
+{code: 0, message:"ok", data: {savedRevisions: 42}}
+{code: 1, message:"padID does not exist", data: null}
+*/
+exports.getSavedRevisionsCount = function(padID, callback)
+{
+  //get the pad
+  getPadSafe(padID, true, function(err, pad)
+  {
+    if(ERR(err, callback)) return;
+
+    callback(null, {savedRevisions: pad.getSavedRevisionsNumber()});
+  });
+}
+
+/**
+listSavedRevisions(padID) returns the list of saved revisions of this pad
+
+Example returns:
+
+{code: 0, message:"ok", data: {savedRevisions: [2, 42, 1337]}}
+{code: 1, message:"padID does not exist", data: null}
+*/
+exports.listSavedRevisions = function(padID, callback)
+{
+  //get the pad
+  getPadSafe(padID, true, function(err, pad)
+  {
+    if(ERR(err, callback)) return;
+
+    callback(null, {savedRevisions: pad.getSavedRevisionsList()});
+  });
+}
+
 /**
 getLastEdited(padID) returns the timestamp of the last revision of the pad
 
diff --git a/src/node/db/Pad.js b/src/node/db/Pad.js
index 2f5860f8f..7a02e0fbd 100644
--- a/src/node/db/Pad.js
+++ b/src/node/db/Pad.js
@@ -54,6 +54,18 @@ Pad.prototype.getHeadRevisionNumber = function getHeadRevisionNumber() {
   return this.head;
 };
 
+Pad.prototype.getSavedRevisionsNumber = function getSavedRevisionsNumber() {
+  return this.savedRevisions.length;
+};
+
+Pad.prototype.getSavedRevisionsList = function getSavedRevisionsList() {
+  var savedRev = new Array();
+  for(var rev in this.savedRevisions){
+    savedRev.push(this.savedRevisions[rev].revNum);
+  }
+  return savedRev;
+};
+
 Pad.prototype.getPublicStatus = function getPublicStatus() {
   return this.publicStatus;
 };
diff --git a/src/node/handler/APIHandler.js b/src/node/handler/APIHandler.js
index a26dd2cfb..a68a4472d 100644
--- a/src/node/handler/APIHandler.js
+++ b/src/node/handler/APIHandler.js
@@ -368,6 +368,8 @@ var version =
   , "setHTML"                   : ["padID", "html"]
   , "getAttributePool"          : ["padID"]
   , "getRevisionsCount"         : ["padID"]
+  , "getSavedRevisionsCount"    : ["padID"]
+  , "listSavedRevisions"        : ["padID"]
   , "getRevisionChangeset"      : ["padID", "rev"]
   , "getLastEdited"             : ["padID"]
   , "deletePad"                 : ["padID"]