Removes history from sites object

Author: NejcZdovc

app/browser/bookmarksExporter.js

@@ -11,20 +11,31 @@ const electron = require('electron')
 const dialog = electron.dialog
 const app = electron.app
 const BrowserWindow = electron.BrowserWindow
-const getSetting = require('../../js/settings').getSetting
+
+// State
+const bookmarkFoldersState = require('../common/state/bookmarkFoldersState')
+const bookmarsState = require('../common/state/bookmarksState')
+
+// Constants
 const settings = require('../../js/constants/settings')
 const siteTags = require('../../js/constants/siteTags')
+
+// Utils
+const {getSetting} = require('../../js/settings')
 const siteUtil = require('../../js/state/siteUtil')
-const isWindows = process.platform === 'win32'
+const platformUtil = require('../common/lib/platformUtil')
+
 const indentLength = 2
 const indentType = ' '
 
-function showDialog (sites) {
+function showDialog (state) {
   const focusedWindow = BrowserWindow.getFocusedWindow()
   const fileName = moment().format('DD_MM_YYYY') + '.html'
   const defaultPath = path.join(getSetting(settings.DEFAULT_DOWNLOAD_SAVE_PATH) || app.getPath('downloads'), fileName)
   let personal = []
   let other = []
+  const bookmarks = bookmarsState.getBookmarks(state)
+  const bookmarkFolders = bookmarkFoldersState.getFolders(state)
 
   dialog.showSaveDialog(focusedWindow, {
     defaultPath: defaultPath,
@@ -34,14 +45,14 @@ function showDialog (sites) {
     }]
   }, (fileName) => {
     if (fileName) {
-      personal = createBookmarkArray(sites)
-      other = createBookmarkArray(sites, -1, false)
+      personal = createBookmarkArray(bookmarks, bookmarkFolders)
+      other = createBookmarkArray(bookmarks, bookmarkFolders, -1, false)
       fs.writeFileSync(fileName, createBookmarkHTML(personal, other))
     }
   })
 }
 
-// TODO refactor this based on the structure
+// TODO refactor this based on the structure (now we send in bookmarks and folders)
 function createBookmarkArray (sites, parentFolderId, first = true, depth = 1) {
   const filteredBookmarks = parentFolderId
     ? sites.filter((site) => site.get('parentFolderId') === parentFolderId)
@@ -71,7 +82,7 @@ function createBookmarkArray (sites, parentFolderId, first = true, depth = 1) {
 }
 
 function createBookmarkHTML (personal, other) {
-  const breakTag = (isWindows) ? '\r\n' : '\n'
+  const breakTag = (platformUtil.isWindows()) ? '\r\n' : '\n'
   const title = 'Bookmarks'
 
   return `<!DOCTYPE NETSCAPE-Bookmark-file-1>

app/browser/menu.js

@@ -401,6 +401,7 @@ const createBookmarksSubmenu = (state) => {
     CommonMenu.exportBookmarksMenuItem()
   ]
 
+  // TODO we should send sites in, but first level bookmarks and folders
   const bookmarks = menuUtil.createBookmarkTemplateItems(state.get('sites'))
   if (bookmarks.length > 0) {
     submenu.push(CommonMenu.separatorMenuItem)

app/browser/reducers/sitesReducer.js

@@ -8,13 +8,15 @@ const Immutable = require('immutable')
 
 // Actions
 const syncActions = require('../../../js/actions/syncActions')
+const appActions = require('../../../js/actions/appActions')
 
 // State
 const siteCache = require('../../common/state/siteCache')
 const tabState = require('../../common/state/tabState')
 const bookmarkFoldersState = require('../../common/state/bookmarkFoldersState')
 const pinnedSitesState = require('../../common/state/pinnedSitesState')
 const bookmarksState = require('../../common/state/bookmarksState')
+const historyState = require('../../common/state/historyState')
 
 // Constants
 const appConstants = require('../../../js/constants/appConstants')
@@ -61,30 +63,17 @@ const sitesReducer = (state, action, immutableAction) => {
         const temp = state.get('tempClearBrowsingData', Immutable.Map())
         const clearData = defaults ? defaults.merge(temp) : temp
         if (clearData.get('browserHistory')) {
-          state = state.set('sites', siteUtil.clearHistory(state.get('sites')))
+          state = historyState.clearSites()
           filtering.clearHistory()
         }
         break
       }
-    case appConstants.APP_ADD_SITE:
+    case appConstants.APP_ADD_HISTORY_SITE:
       {
         const isSyncEnabled = syncEnabled()
-        if (Immutable.List.isList(action.siteDetail)) {
-          action.siteDetail.forEach((s) => {
-            state = siteUtil.addSite(state, s, action.tag, action.skipSync)
-            if (isSyncEnabled) {
-              state = syncUtil.updateSiteCache(state, s)
-            }
-          })
-        } else {
-          let sites = state.get('sites')
-          if (!action.siteDetail.get('folderId') && siteUtil.isFolder(action.siteDetail)) {
-            action.siteDetail = action.siteDetail.set('folderId', siteUtil.getNextFolderId(sites))
-          }
-          state = siteUtil.addSite(state, action.siteDetail, action.tag, action.skipSync)
-          if (isSyncEnabled) {
-            state = syncUtil.updateSiteCache(state, action.siteDetail)
-          }
+        state = historyState.addSite(state, action.siteDetail)
+        if (isSyncEnabled) {
+          state = syncUtil.updateSiteCache(state, action.siteDetail)
         }
         break
       }
@@ -113,6 +102,12 @@ const sitesReducer = (state, action, immutableAction) => {
         state = updateActiveTabBookmarked(state)
         break
       }
+    case appConstants.APP_ADD_BOOKMARKS:
+      {
+        // TODO we need to do it like this until we implement action inside actions
+        action.bookmarkList.forEach(bookmark => appActions.addBookmark(bookmark))
+        break
+      }
     case appConstants.APP_EDIT_BOOKMARK:
       {
         const isSyncEnabled = syncEnabled()
@@ -160,6 +155,12 @@ const sitesReducer = (state, action, immutableAction) => {
         }
         break
       }
+    case appConstants.APP_ADD_BOOKMARK_FOLDERS:
+      {
+        // TODO we need to do it like this until we implement action inside actions
+        action.folderList.forEach(folder => appActions.addBookmarkFolder(folder))
+        break
+      }
     case appConstants.APP_EDIT_BOOKMARK_FOLDER:
       {
         const isSyncEnabled = syncEnabled()
@@ -182,7 +183,7 @@ const sitesReducer = (state, action, immutableAction) => {
         state = bookmarkFoldersState.removeFolder(state, action.folderKey)
         break
       }
-    case appConstants.APP_REMOVE_SITE:
+    case appConstants.APP_REMOVE_HISTORY_SITE:
       const removeSiteSyncCallback = action.skipSync ? undefined : syncActions.removeSite
       state = siteUtil.removeSite(state, action.siteDetail, action.tag, true, removeSiteSyncCallback)
       if (syncEnabled()) {
@@ -241,7 +242,7 @@ const sitesReducer = (state, action, immutableAction) => {
           console.warn('Trying to pin a tabId which does not exist:', tabId, 'tabs: ', state.get('tabs').toJS())
           break
         }
-        const sites = state.get('sites')
+        const sites = pinnedSitesState.getSites(state)
         const siteDetail = pinnedSitesUtil.getDetailsFromTab(sites, tab)
         if (pinned) {
           state = pinnedSitesState.addPinnedSite(state, siteDetail)

app/browser/reducers/urlBarSuggestionsReducer.js

@@ -7,24 +7,18 @@
 const appConstants = require('../../../js/constants/appConstants')
 const {generateNewSuggestionsList, generateNewSearchXHRResults} = require('../../common/lib/suggestion')
 const {init, add} = require('../../common/lib/siteSuggestions')
-const Immutable = require('immutable')
 const {makeImmutable} = require('../../common/state/immutableUtil')
 const tabState = require('../../common/state/tabState')
 
 const urlBarSuggestionsReducer = (state, action) => {
   switch (action.actionType) {
-    case appConstants.APP_ADD_SITE:
+    case appConstants.APP_ADD_HISTORY_SITE:
     case appConstants.APP_ADD_BOOKMARK:
     case appConstants.APP_EDIT_BOOKMARK:
-      if (Immutable.List.isList(action.siteDetail)) {
-        action.siteDetail.forEach((s) => {
-          add(s)
-        })
-      } else {
-        add(action.siteDetail)
-      }
+      add(action.siteDetail)
       break
     case appConstants.APP_SET_STATE:
+      // TODO do we need to merge bookmarks and history into one?
       init(Object.values(action.appState.get('sites').toJS()))
       break
     case appConstants.APP_URL_BAR_TEXT_CHANGED:

app/browser/tabs.js

@@ -29,6 +29,7 @@ const {isResourceEnabled} = require('../filtering')
 const autofill = require('../autofill')
 const bookmarksState = require('../common/state/bookmarksState')
 const bookmarkFoldersState = require('../common/state/bookmarkFoldersState')
+const historyState = require('../common/state/historyState')
 
 let currentPartitionNumber = 0
 const incrementPartitionNumber = () => ++currentPartitionNumber
@@ -797,7 +798,7 @@ const api = {
 
   getHistoryEntries: (state, action) => {
     const tab = getWebContents(action.get('tabId'))
-    const sites = state ? state.get('sites') : null
+    const sites = state ? historyState.getSites(state) : null
 
     if (tab && !tab.isDestroyed()) {
       let history = {
@@ -821,7 +822,7 @@ const api = {
           // TODO: return brave lion (or better: get icon from extension if possible as data URI)
         } else {
           if (sites) {
-            const site = sites.find(function (element) { return element.get('location') === url })
+            const site = sites.find((element) => element.get('location') === url)
             if (site) {
               entry.icon = site.get('favicon')
             }

app/common/lib/bookmarkFoldersUtil.js

@@ -5,10 +5,10 @@ const isFolderNameValid = (title) => {
   return (title != null && title !== 0) && title.trim().length > 0
 }
 
-const getNextFolderIdItem = (sites) =>
-  sites.max((siteA, siteB) => {
-    const folderIdA = siteA.get('folderId')
-    const folderIdB = siteB.get('folderId')
+const getNextFolderIdItem = (folders) =>
+  folders.max((folderA, folderB) => {
+    const folderIdA = folderA.get('folderId')
+    const folderIdB = folderB.get('folderId')
     if (folderIdA === folderIdB) {
       return 0
     }
@@ -21,12 +21,12 @@ const getNextFolderIdItem = (sites) =>
     return folderIdA > folderIdB
   })
 
-const getNextFolderId = (sites) => {
+const getNextFolderId = (folders) => {
   const defaultFolderId = 0
-  if (!sites) {
+  if (!folders) {
     return defaultFolderId
   }
-  const maxIdItem = getNextFolderIdItem(sites)
+  const maxIdItem = getNextFolderIdItem(folders)
   return (maxIdItem ? (maxIdItem.get('folderId') || 0) : 0) + 1
 }
 

app/common/lib/historyUtil.js

@@ -8,15 +8,15 @@ const {makeImmutable} = require('../state/immutableUtil')
 const siteUtil = require('../../../js/state/siteUtil')
 const aboutHistoryMaxEntries = 500
 
-module.exports.maxEntries = aboutHistoryMaxEntries
+const maxEntries = aboutHistoryMaxEntries
 
 const sortTimeDescending = (left, right) => {
   if (left.get('lastAccessedTime') < right.get('lastAccessedTime')) return 1
   if (left.get('lastAccessedTime') > right.get('lastAccessedTime')) return -1
   return 0
 }
 
-module.exports.getHistory = (sites) => {
+const getHistory = (sites) => {
   sites = makeImmutable(sites) ? makeImmutable(sites).toList() : new Immutable.List()
   return sites.filter((site) => siteUtil.isHistoryEntry(site))
       .sort(sortTimeDescending)
@@ -30,7 +30,7 @@ const getDayString = (entry, locale) => {
     : ''
 }
 
-module.exports.groupEntriesByDay = (history, locale) => {
+const groupEntriesByDay = (history, locale) => {
   const reduced = history.reduce((previousValue, currentValue, currentIndex, array) => {
     const result = currentIndex === 1 ? [] : previousValue
     if (currentIndex === 1) {
@@ -60,7 +60,7 @@ module.exports.groupEntriesByDay = (history, locale) => {
  * Return an array with ALL entries.
  * Format is expected to be array containing one array per day.
  */
-module.exports.totalEntries = (entriesByDay) => {
+const totalEntries = (entriesByDay) => {
   entriesByDay = makeImmutable(entriesByDay) || new Immutable.List()
 
   let result = new Immutable.List()
@@ -69,3 +69,10 @@ module.exports.totalEntries = (entriesByDay) => {
   })
   return result
 }
+
+module.exports = {
+  maxEntries,
+  getHistory,
+  groupEntriesByDay,
+  totalEntries
+}

app/common/lib/pinnedSitesUtil.js

@@ -1,3 +1,7 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
 const Immutable = require('immutable')
 const siteUtil = require('../../../js/state/siteUtil')
 const {makeImmutable} = require('../state/immutableUtil')

app/common/state/aboutHistoryState.js

@@ -2,18 +2,26 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+const Immutable = require('immutable')
 const {makeImmutable} = require('./immutableUtil')
-const historyUtil = require('../lib/historyUtil')
+const historyState = require('./historyState')
 
 const aboutHistoryState = {
   getHistory: (state) => {
     state = makeImmutable(state)
     return state.getIn(['about', 'history'])
   },
+
   setHistory: (state) => {
     state = makeImmutable(state)
-    state = state.setIn(['about', 'history', 'entries'],
-      historyUtil.getHistory(state.get('sites')))
+    // TODO make sure that they are sorted
+    state = state.setIn(['about', 'history', 'entries'], historyState.getSites(state))
+    return state.setIn(['about', 'history', 'updatedStamp'], new Date().getTime())
+  },
+
+  clearHistory: (state) => {
+    state = makeImmutable(state)
+    state = state.setIn(['about', 'history', 'entries'], Immutable.Map())
     return state.setIn(['about', 'history', 'updatedStamp'], new Date().getTime())
   }
 }

app/common/state/aboutNewTabState.js

@@ -5,6 +5,7 @@
 const Immutable = require('immutable')
 const {makeImmutable} = require('./immutableUtil')
 const {isSourceAboutUrl} = require('../../../js/lib/appUrlUtil')
+const historyState = require('./historyState')
 const aboutNewTabMaxEntries = 18
 
 const pinnedTopSites = (state) => {
@@ -50,8 +51,7 @@ const getTopSites = (state) => {
     return Immutable.Map()
   }
 
-  // TODO change to historySites
-  return state.get('sites')
+  return historyState.getSites(state)
     .filter((site, key) => !isSourceAboutUrl(site.get('location')) && !isPinned(state, key) && !isIgnored(state, key))
     .sort(sortCountDescending)
     .slice(0, aboutNewTabMaxEntries)
@@ -80,6 +80,13 @@ const aboutNewTabState = {
     // return a filtered version of the sites array
     state = state.setIn(['about', 'newtab', 'sites'], getTopSites(state))
     return state.setIn(['about', 'newtab', 'updatedStamp'], new Date().getTime())
+  },
+
+  clearTopSites: (state) => {
+    state = makeImmutable(state)
+
+    state = state.setIn(['about', 'newtab', 'sites'], Immutable.Map())
+    return state.setIn(['about', 'newtab', 'updatedStamp'], new Date().getTime())
   }
 }