recentfiles.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
import os.path
 
import wx
 
from ..pluginapi import Plugin
from ..action import ActionInfo, SeparatorInfo
from ..publish import RideOpenSuite, RideFileNameChanged
from ..publish.messages import RideNewProject, RideSaved
 
 
def normalize_path(path):
    if os.path.basename(path).startswith('__init__.'):
        return os.path.dirname(path)
    return os.path.abspath(path)
 
 
def remove_non_existing_paths(paths):
    return [f for f in paths if os.path.exists(f)]
 
 
 
class RecentFilesPlugin(Plugin):
 
    def __init__(self, application=None):
        settings = {'recent_files': [], 'max_number_of_files': 4}
        Plugin.__init__(self, application, default_settings=settings)
        self.recent_filesrecent_files = remove_non_existing_paths(self.recent_filesrecent_files)
 
    def enable(self):
        self._save_currently_loaded_suite_save_currently_loaded_suite()
        self._add_recent_files_to_menu_add_recent_files_to_menu()
        self._new_project_path_new_project_path = None
        self.subscribesubscribe(self.OnSuiteOpenedOnSuiteOpened, RideOpenSuite)
        self.subscribesubscribe(self.OnFileNameChangedOnFileNameChanged, RideFileNameChanged)
        self.subscribesubscribe(self.OnNewProjectOpenedOnNewProjectOpened, RideNewProject)
        self.subscribesubscribe(self.OnSavedOnSaved, RideSaved)
 
    def disable(self):
        self.unregister_actionsunregister_actions()
        self.unsubscribe_allunsubscribe_all()
 
    def OnSuiteOpened(self, message):
        # Update menu with CallAfter to ensure ongoing menu selection
        # handling has finished before menu is changed
        wx.CallAfter(self._add_to_recent_files_add_to_recent_files, message.path)
        self._new_project_path_new_project_path = None
 
    def OnFileNameChanged(self, message):
        self._new_project_path_new_project_path = None
        if not message.old_filename:
            return
        old_filename = normalize_path(message.old_filename)
        new_filename = normalize_path(message.datafile.filename)
        if old_filename not in self.recent_filesrecent_files:
            return
        index = self.recent_filesrecent_files.index(old_filename)
        self.recent_filesrecent_files[index] = new_filename
        self._save_settings_and_update_file_menu_save_settings_and_update_file_menu()
 
    def OnNewProjectOpened(self, message):
        self._new_project_path_new_project_path = message.path
 
    def OnSaved(self, message):
        if self._new_project_path_new_project_path is not None:
            wx.CallAfter(self._add_to_recent_files_add_to_recent_files, self._new_project_path_new_project_path)
            self._new_project_path_new_project_path = None
 
    def _get_file_menu(self):
        menubar = self.get_menu_bar()
        pos = menubar.FindMenu('File')
        file_menu = menubar.GetMenu(pos)
        return file_menu
 
    def _save_currently_loaded_suite(self):
        model = self.modelmodel
        if model and model.suite:
            self._add_to_recent_files_add_to_recent_files(model.suite.source)
 
    def _add_to_recent_files(self, path):
        if not path:
            return
        path = normalize_path(path)
        if path in self.recent_filesrecent_files:
            self.recent_filesrecent_files.remove(path)
        self.recent_filesrecent_files.insert(0, path)
        self._save_settings_and_update_file_menu_save_settings_and_update_file_menu()
 
    def _save_settings_and_update_file_menu(self):
        self.recent_filesrecent_files = remove_non_existing_paths(self.recent_filesrecent_files)
        self.recent_filesrecent_files = self.recent_filesrecent_files[:self.max_number_of_files]
        self.save_settingsave_setting('recent_files', self.recent_filesrecent_files)
        self.unregister_actionsunregister_actions()
        self._add_recent_files_to_menu_add_recent_files_to_menu()
 
    def _add_recent_files_to_menu(self):
        if not self.recent_filesrecent_files:
            action = ActionInfo('File', 'No recent files')
            action.set_menu_position(before='Exit')
            self.register_actionregister_action(action)
        else:
            for n, path in enumerate(self.recent_filesrecent_files):
                self._add_file_to_menu_add_file_to_menu(path, n)
        sep = SeparatorInfo('File')
        sep.set_menu_position(before='Exit')
        self.register_actionregister_action(sep)
 
    def _add_file_to_menu(self, path, n):
        entry = RecentFileEntry(n+1, path, self)
        self.register_actionregister_action(entry.get_action_info())
 
 
class RecentFileEntry():
 
    def __init__(self, index, file, plugin):
        self.filefile = file
        self.indexindex = index
        self.pathpath = normalize_path(self.filefile)
        self.filenamefilename = os.path.basename(file)
        self.pluginplugin = plugin
        self.labellabel = '&%s: %s' % (index, self.filenamefilename)
        self.docdoc = 'Open %s' % self.pathpath
 
    def OnOpenRecent(self, event):
        if not self.pluginplugin.frame.check_unsaved_modifications():
            return
        self.pluginplugin.open_suite(self.pathpath)
 
    def get_action_info(self):
        action_info = ActionInfo('File', self.labellabel, self.OnOpenRecentOnOpenRecent,
                                 doc=self.docdoc)
        action_info.set_menu_position(before='Exit')
        return action_info