Skip to content
This repository has been archived by the owner on Dec 11, 2019. It is now read-only.

Commit

Permalink
Merge pull request #3813 from brave/menu-updates
Browse files Browse the repository at this point in the history 
only update the menu when bookmarks or closed tabs change
  • Loading branch information
@bbondy
bbondy authored Sep 8, 2016
2 parents 7edc0ce + 8b0e958 commit 12c204f
Show file tree
Hide file tree
Showing 15 changed files with 204 additions and 397 deletions.
51 changes: 3 additions & 48 deletions app/browser/lib/menuUtil.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ const eventUtil = require('../../../js/lib/eventUtil')
const siteUtil = require('../../../js/state/siteUtil')
const locale = require('../../locale')

// States which can trigger dynamic menus to change
let lastSettingsState, lastSites, lastClosedFrames

/**
* Get an electron MenuItem object for the PARENT menu (File, Edit, etc) based on its label
* @param {string} label - the text associated with the menu
Expand Down Expand Up @@ -55,45 +52,6 @@ module.exports.getMenuItem = (appMenu, label) => {
return null
}

/**
* Check for uneeded updates.
* Updating the menu when it is not needed causes the menu to close if expanded
* and also causes menu clicks to not work. So we don't want to update it a lot.
* Should only be updated when appState or windowState change (for history or bookmarks)
* NOTE: settingsState is not used directly; it gets used indirectly via getSetting()
* @param {Object} appState - Application state. Used to fetch bookmarks and settings (like homepage)
* @param {Object} windowData - Information specific to the current window (recently closed tabs, etc)
*/
module.exports.checkForUpdate = (appState, windowData) => {
const updated = {
nothing: true,
settings: false,
sites: false,
closedFrames: false
}

if (appState && appState.get('settings') !== lastSettingsState) {
// Currently only used for the HOMEPAGE value (bound to history menu)
lastSettingsState = appState.get('settings')
updated.nothing = false
updated.settings = true
}

if (appState && appState.get('sites') !== lastSites) {
lastSites = appState.get('sites')
updated.nothing = false
updated.sites = true
}

if (windowData && windowData.get('closedFrames') !== lastClosedFrames) {
lastClosedFrames = windowData.get('closedFrames')
updated.nothing = false
updated.closedFrames = true
}

return updated
}

const createBookmarkMenuItems = (bookmarks, parentFolderId) => {
const filteredBookmarks = parentFolderId
? bookmarks.filter((bookmark) => bookmark.get('parentFolderId') === parentFolderId)
Expand Down Expand Up @@ -131,14 +89,11 @@ const createBookmarkMenuItems = (bookmarks, parentFolderId) => {
return payload
}

module.exports.createBookmarkMenuItems = () => {
if (lastSites) {
return createBookmarkMenuItems(siteUtil.getBookmarks(lastSites))
}
return []
module.exports.createBookmarkMenuItems = (sites) => {
return createBookmarkMenuItems(siteUtil.getBookmarks(sites))
}

module.exports.createRecentlyClosedMenuItems = () => {
module.exports.createRecentlyClosedMenuItems = (lastClosedFrames) => {
const payload = []
if (lastClosedFrames && lastClosedFrames.size > 0) {
payload.push(
Expand Down
181 changes: 89 additions & 92 deletions app/browser/menu.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,17 @@
const Immutable = require('immutable')
const electron = require('electron')
const appConfig = require('../../js/constants/appConfig')
const appActions = require('../../js/actions/appActions')
const appConstants = require('../../js/constants/appConstants')
const appDispatcher = require('../../js/dispatcher/appDispatcher')
const appStore = require('../../js/stores/appStore')
const windowConstants = require('../../js/constants/windowConstants')
const Menu = electron.Menu
const MenuItem = electron.MenuItem
const CommonMenu = require('../common/commonMenu')
const messages = require('../../js/constants/messages')
const settings = require('../../js/constants/settings')
const siteTags = require('../../js/constants/siteTags')
const dialog = electron.dialog
const appActions = require('../../js/actions/appActions')
const { fileUrl } = require('../../js/lib/appUrlUtil')
const menuUtil = require('./lib/menuUtil')
const getSetting = require('../../js/settings').getSetting
Expand All @@ -21,15 +26,13 @@ const {isSiteBookmarked} = require('../../js/state/siteUtil')
const isDarwin = process.platform === 'darwin'
const aboutUrl = 'https://brave.com/'

// Start off with an empty menu
let appMenu = Menu.buildFromTemplate([])
Menu.setApplicationMenu(appMenu)

// Value for history menu's "Bookmark Page" menu item; see createBookmarksSubmenu()
let isBookmarkChecked = false
let appMenu = null
// TODO(bridiver) - these should be handled in the appStore
let closedFrames = {}
let currentLocation = null

// Submenu initialization
const createFileSubmenu = (CommonMenu) => {
const createFileSubmenu = () => {
const submenu = [
CommonMenu.newTabMenuItem(),
CommonMenu.newPrivateTabMenuItem(),
Expand Down Expand Up @@ -121,7 +124,7 @@ const createFileSubmenu = (CommonMenu) => {
return submenu
}

const createEditSubmenu = (CommonMenu) => {
const createEditSubmenu = () => {
const submenu = [
{
label: locale.translation('undo'),
Expand Down Expand Up @@ -186,7 +189,7 @@ const createEditSubmenu = (CommonMenu) => {
return submenu
}

const createViewSubmenu = (CommonMenu) => {
const createViewSubmenu = () => {
return [
{
label: locale.translation('actualSize'),
Expand Down Expand Up @@ -287,7 +290,7 @@ const createViewSubmenu = (CommonMenu) => {
]
}

const createHistorySubmenu = (CommonMenu) => {
const createHistorySubmenu = () => {
let submenu = [
{
label: locale.translation('home'),
Expand Down Expand Up @@ -347,8 +350,7 @@ const createHistorySubmenu = (CommonMenu) => {
}
}
]

submenu = submenu.concat(menuUtil.createRecentlyClosedMenuItems())
submenu = submenu.concat(menuUtil.createRecentlyClosedMenuItems(Immutable.fromJS(Object.keys(closedFrames).map(key => closedFrames[key]))))

submenu.push(
// TODO: recently visited
Expand All @@ -363,13 +365,17 @@ const createHistorySubmenu = (CommonMenu) => {
return submenu
}

const createBookmarksSubmenu = (CommonMenu) => {
const isCurrentLocationBookmarked = () => {
return isSiteBookmarked(appStore.getState().get('sites'), Immutable.fromJS({location: currentLocation}))
}

const createBookmarksSubmenu = () => {
let submenu = [
{
label: locale.translation('bookmarkPage'),
type: 'checkbox',
accelerator: 'CmdOrCtrl+D',
checked: isBookmarkChecked, // NOTE: checked status is updated via updateBookmarkedStatus()
checked: isCurrentLocationBookmarked(),
click: function (item, focusedWindow) {
var msg = item.checked
? messages.SHORTCUT_ACTIVE_FRAME_REMOVE_BOOKMARK
Expand All @@ -389,7 +395,7 @@ const createBookmarksSubmenu = (CommonMenu) => {
CommonMenu.importBookmarksMenuItem()
]

const bookmarks = menuUtil.createBookmarkMenuItems()
const bookmarks = menuUtil.createBookmarkMenuItems(appStore.getState().get('sites'))
if (bookmarks.length > 0) {
submenu.push(CommonMenu.separatorMenuItem)
submenu = submenu.concat(bookmarks)
Expand All @@ -398,7 +404,7 @@ const createBookmarksSubmenu = (CommonMenu) => {
return submenu
}

const createWindowSubmenu = (CommonMenu) => {
const createWindowSubmenu = () => {
return [
{
label: locale.translation('minimize'),
Expand Down Expand Up @@ -441,7 +447,7 @@ const createWindowSubmenu = (CommonMenu) => {
]
}

const createHelpSubmenu = (CommonMenu) => {
const createHelpSubmenu = () => {
const submenu = [
CommonMenu.reportAnIssueMenuItem(),
CommonMenu.separatorMenuItem,
Expand All @@ -465,7 +471,7 @@ const createHelpSubmenu = (CommonMenu) => {
return submenu
}

const createDebugSubmenu = (CommonMenu) => {
const createDebugSubmenu = () => {
return [
{
// Makes future renderer processes pause when they are created until a debugger appears.
Expand Down Expand Up @@ -510,26 +516,26 @@ const createDebugSubmenu = (CommonMenu) => {
* Will only build the initial menu, which is mostly static items
* Dynamic items (Bookmarks, History) get updated w/ updateMenu
*/
const createMenu = (CommonMenu) => {
const createMenu = () => {
const template = [
{ label: locale.translation('file'), submenu: createFileSubmenu(CommonMenu) },
{ label: locale.translation('edit'), submenu: createEditSubmenu(CommonMenu) },
{ label: locale.translation('view'), submenu: createViewSubmenu(CommonMenu) },
{ label: locale.translation('history'), submenu: createHistorySubmenu(CommonMenu) },
{ label: locale.translation('bookmarks'), submenu: createBookmarksSubmenu(CommonMenu) },
{ label: locale.translation('file'), submenu: createFileSubmenu() },
{ label: locale.translation('edit'), submenu: createEditSubmenu() },
{ label: locale.translation('view'), submenu: createViewSubmenu() },
{ label: locale.translation('history'), submenu: createHistorySubmenu() },
{ label: locale.translation('bookmarks'), submenu: createBookmarksSubmenu() },
{
label: locale.translation('bravery'),
submenu: [
CommonMenu.braveryGlobalMenuItem(),
CommonMenu.braverySiteMenuItem()
]
},
{ label: locale.translation('window'), submenu: createWindowSubmenu(CommonMenu), role: 'window' },
{ label: locale.translation('help'), submenu: createHelpSubmenu(CommonMenu), role: 'help' }
{ label: locale.translation('window'), submenu: createWindowSubmenu(), role: 'window' },
{ label: locale.translation('help'), submenu: createHelpSubmenu(), role: 'help' }
]

if (process.env.NODE_ENV === 'development') {
template.push({ label: 'Debug', submenu: createDebugSubmenu(CommonMenu) })
template.push({ label: 'Debug', submenu: createDebugSubmenu() })
}

if (isDarwin) {
Expand Down Expand Up @@ -572,81 +578,72 @@ const createMenu = (CommonMenu) => {
})
}

const oldMenu = appMenu
let oldMenu = appMenu
appMenu = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(appMenu)
if (oldMenu) {
oldMenu.destroy()
}
}

const updateMenu = (CommonMenu, appState, windowData) => {
const updated = menuUtil.checkForUpdate(appState, windowData)
if (updated.nothingUpdated) {
return
}

// When bookmarks are removed via AppStore (context menu, etc), `isBookmarkChecked` needs to be recalculated
if (windowData && windowData.get('location')) {
isBookmarkChecked = isSiteBookmarked(appState.get('sites'), Immutable.fromJS({location: windowData.get('location')}))
}

// Only rebuild menus when necessary

if (updated.settings || updated.closedFrames) {
let historyMenu = menuUtil.getParentMenuDetails(appMenu, locale.translation('history'))
if (historyMenu && historyMenu.menu && historyMenu.menu.submenu && historyMenu.index !== -1) {
const menu = historyMenu.menu.submenu
const menuItems = createHistorySubmenu(CommonMenu)
menu.clear()
menuItems.forEach((item) => menu.append(new MenuItem(item)))
}
}

if (updated.sites) {
let bookmarksMenu = menuUtil.getParentMenuDetails(appMenu, locale.translation('bookmarks'))
if (bookmarksMenu && bookmarksMenu.menu && bookmarksMenu.menu.submenu && bookmarksMenu.index !== -1) {
const menu = bookmarksMenu.menu.submenu
const menuItems = createBookmarksSubmenu(CommonMenu)
menu.clear()
menuItems.forEach((item) => menu.append(new MenuItem(item)))
}
const doAction = (action) => {
switch (action.actionType) {
case windowConstants.WINDOW_SET_FOCUSED_FRAME:
// TODO check/uncheck menu item instead of recreating menu
currentLocation = action.frameProps.get('location')
let menuItem = menuUtil.getMenuItem(appMenu, locale.translation('bookmarkPage'))
menuItem.checked = isCurrentLocationBookmarked()
break
case windowConstants.WINDOW_UNDO_CLOSED_FRAME:
appDispatcher.waitFor([appStore.dispatchToken], () => {
delete closedFrames[action.frameProps.get('location')]
createMenu()
})
break
case windowConstants.WINDOW_CLEAR_CLOSED_FRAMES:
appDispatcher.waitFor([appStore.dispatchToken], () => {
closedFrames = {}
createMenu()
})
break
case windowConstants.WINDOW_CLOSE_FRAME:
appDispatcher.waitFor([appStore.dispatchToken], () => {
if (!action.frameProps.get('isPrivate') && action.frameProps.get('location') !== 'about:newtab') {
closedFrames[action.frameProps.get('location')] = action.frameProps
createMenu()
}
})
break
case appConstants.APP_ADD_SITE:
if (action.tag === siteTags.BOOKMARK) {
appDispatcher.waitFor([appStore.dispatchToken], () => {
createMenu()
})
}
break
case appConstants.APP_REMOVE_SITE:
if (action.tag === siteTags.BOOKMARK) {
appDispatcher.waitFor([appStore.dispatchToken], () => {
createMenu()
})
}
break
case appConstants.APP_CLEAR_HISTORY:
if (action.tag === siteTags.BOOKMARK) {
appDispatcher.waitFor([appStore.dispatchToken], () => {
createMenu()
})
}
break
default:
}

Menu.setApplicationMenu(appMenu)
}

/**
* Sets up the menu.
* @param {Object} appState - Application state. Used to fetch bookmarks and settings (like homepage)
* @param {Object} windowData - Information specific to the current window (recently closed tabs, etc)
*/
module.exports.rebuild = (appState, windowData) => {
// The menu will always be called once localization is done
// so don't bother loading anything until it is done.
if (!locale.initialized) {
return
}

// This needs to be within the init method to handle translations
const CommonMenu = require('../common/commonMenu')
if (appMenu.items.length === 0) {
createMenu(CommonMenu)
} else {
updateMenu(CommonMenu, appState, windowData)
}
}

/**
* Called from navigationBar.js; used to update bookmarks menu status
* @param {boolean} isBookmarked - true if the currently viewed site is bookmarked
*/
module.exports.updateBookmarkedStatus = (isBookmarked) => {
const menuItem = menuUtil.getMenuItem(locale.translation('bookmarkPage'))
if (menuItem) {
menuItem.checked = isBookmarked
}
// menu may be rebuilt without the location changing
// this holds the last known status
isBookmarkChecked = isBookmarked
module.exports.init = (appState) => {
createMenu()
appDispatcher.register(doAction)
}
Loading

0 comments on commit 12c204f

Please sign in to comment.