diff options
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/meld.py | 44 | ||||
| -rw-r--r-- | examples/open-terminal.py | 3 | ||||
| -rw-r--r-- | examples/shred.py | 191 |
3 files changed, 237 insertions, 1 deletions
diff --git a/examples/meld.py b/examples/meld.py new file mode 100644 index 0000000..15fff1f --- /dev/null +++ b/examples/meld.py @@ -0,0 +1,44 @@ +# Examples: https://github.com/mate-desktop/python-caja/tree/master/examples + +import os +import subprocess + +from gi.repository import Caja, GObject + + +class MeldMenuProvider(GObject.GObject, Caja.MenuProvider): + MELD_EXECUTABLE = 'meld' + MELD_ICON = '/usr/share/icons/hicolor/scalable/apps/org.gnome.Meld.svg' + + def __init__(self): + pass + + def menu_activate_cb(self, menu, files=None): + if files and len(files): + # Set working directory + os.chdir(os.path.dirname(files[0].get_location().get_path())) + + # Start Meld + cmd_args = [self.MELD_EXECUTABLE] + if files and len(files): + for i in range(0, min(3, len(files))): + cmd_args.append(files[i].get_location().get_path()) + subprocess.Popen(cmd_args) + + def get_file_items(self, window, files): + top_menuitem = Caja.MenuItem(name='MeldMenuProvider::Meld', + label='Meld compare', + tip='Compare files and folders using Meld', + icon=self.MELD_ICON) + top_menuitem.connect('activate', self.menu_activate_cb, files) + + return top_menuitem, + + def get_background_items(self, window, file): + bg_menuitem_meld = Caja.MenuItem(name='MeldMenuProvider::MeldBg', + label='Meld', + tip='Compare files and folders using Meld', + icon=self.MELD_ICON) + bg_menuitem_meld.connect('activate', self.menu_activate_cb) + + return bg_menuitem_meld, diff --git a/examples/open-terminal.py b/examples/open-terminal.py index 935d894..ff0909e 100644 --- a/examples/open-terminal.py +++ b/examples/open-terminal.py @@ -1,5 +1,6 @@ # This example is contributed by Martin Enlund import os +import subprocess from gi.repository import Caja, GObject, Gio @@ -15,7 +16,7 @@ class OpenTerminalExtension(Caja.MenuProvider, GObject.GObject): terminal = self.gsettings[TERMINAL_KEY] os.chdir(filename) - os.system('%s &' % terminal) + subprocess.Popen([terminal], cwd=filename) def menu_activate_cb(self, menu, file): self._open_terminal(file) diff --git a/examples/shred.py b/examples/shred.py new file mode 100644 index 0000000..de95ac5 --- /dev/null +++ b/examples/shred.py @@ -0,0 +1,191 @@ +# Examples: https://github.com/mate-desktop/python-caja/tree/master/examples +# +# This script adds a new menu's to Caja file browser: +# - Shred: when right-mouse clicking on one or more selected files +# or directories. +# - Wipe freespace: when right-mouse clicking on a white area without +# selected files or directories. +# The executed command is shown in the statusbar. +# +# WARNING: THIS IS AN EXAMPLE SCRIPT AND THE USER IS RESPONSIBLE +# FOR SHREDDING THE FULL SSD OR HARD DRIVE WHEN ABSOLUTE SECURITY IS +# REQUIRED! +# +# The Linux tool `shred` is used to shred files by filling files with +# zero's or random data and removes filenames. Overwriting files +# multiple times has no effect on SSD's and decreases lifetime. It +# should be used for mechanical hard drives only. +# +# Copy this script to a path defined in $XDG_DATA_DIRS, for example: +# ~/.local/share/caja-python/extensions + +import os +import subprocess + +import gi +from gi.repository import Caja, GObject, Gio, Gtk + + +class ShredMenuProvider(GObject.GObject, Caja.MenuProvider): + SHRED_ICON = '/usr/share/pixmaps/caja/erase.png' + WIPE_CMD = 'dd if=/dev/{} of={} bs=1M' + WIPE_FILENAME = 'tmp' + + def __init__(self): + pass + + def shred_menu_activate_cb(self, menu, data): + dialog = Gtk.MessageDialog( + parent=None, + flags=0, + message_type=Gtk.MessageType.QUESTION, + buttons=Gtk.ButtonsType.YES_NO, + title="Caja shred", + text="Are you sure you want to shred selected files?", + ) + dialog.format_secondary_text("WARNING: This cannot be undone!") + response = dialog.run() + dialog.destroy() + if response == Gtk.ResponseType.YES: + files_skipped = False + shred_files = [] + for shred_file in data['files']: + file_path = shred_file.get_location().get_path() + if os.access(file_path, os.W_OK): + shred_files.append(file_path) + else: + print('Skip shred file: {}'.format(file_path)) + files_skipped = True + + # Start Shred command + if shred_files: + shred_args = data['cmd'].split() + cmd = shred_args + shred_files + print('Running: {}'.format(' '.join(shred_args + ['"{}"'.format(p) for p in shred_files]))) + subprocess.check_call(cmd) + + dialog = Gtk.MessageDialog( + parent=None, + flags=0, + message_type=Gtk.MessageType.INFO, + buttons=Gtk.ButtonsType.OK, + title="Caja shred", + text='Shred completed.', + ) + if files_skipped: + dialog.format_secondary_text('WARNING: Some files could not be shredded.\nPlease check manually.') + + response = dialog.run() + dialog.destroy() + + def wipe_freespace_menu_activate_cb(self, menu, data): + wipe_path = data['file'].get_location().get_path() + wipe_file = os.path.join(wipe_path, self.WIPE_FILENAME) + wipe_cmd = data['cmd'].replace('of=' + self.WIPE_FILENAME, 'of=' + wipe_file).split() + + # Check if wipe path is writable + if not os.access(wipe_path, os.W_OK): + dialog = Gtk.MessageDialog( + parent=None, + flags=0, + message_type=Gtk.MessageType.ERROR, + buttons=Gtk.ButtonsType.OK, + title="Caja wipe freespace", + text="Error: Directory is not writable", + ) + response = dialog.run() + dialog.destroy() + return + + # Start wipe freespace command + print('Running: {}'.format(' '.join(wipe_cmd))) + try: + subprocess.check_call(wipe_cmd) + except subprocess.CalledProcessError: + # Ignore disk full error + pass + + print('Running: sync') + subprocess.check_call(['sync']) + + print('Running: rm "{}"'.format(wipe_file)) + subprocess.check_call(['rm', wipe_file]) + + dialog = Gtk.MessageDialog( + parent=None, + flags=0, + message_type=Gtk.MessageType.INFO, + buttons=Gtk.ButtonsType.OK, + title="Caja wipe freespace", + text="Wipe freespace completed!", + ) + response = dialog.run() + dialog.destroy() + + def get_file_items(self, window, files): + top_menuitem = Caja.MenuItem(name='ShredMenuProvider::Shred', + label='Shred', + tip='Delete files with the Linux "shred" tool', + icon=self.SHRED_ICON) + + shred_submenu = Caja.Menu() + top_menuitem.set_submenu(shred_submenu) + + # Shred fill zero's + shred_cmd = 'shred -uz -n 0' + shred_1x_zero_menuitem = Caja.MenuItem(name='ShredMenuProvider::Shred1xZero', + label='Fill zero\'s', + tip=shred_cmd + ' FILE... (NOT SECURE!)', + icon=self.SHRED_ICON) + shred_1x_zero_menuitem.connect('activate', self.shred_menu_activate_cb, {'cmd': shred_cmd, 'files': files}) + shred_submenu.append_item(shred_1x_zero_menuitem) + + # Shred fill random + shred_cmd = 'shred -u -n 1' + shred_1x_random_menuitem = Caja.MenuItem(name='ShredMenuProvider::Shred1xRandom', + label='Fill random', + tip=shred_cmd + ' FILE... (NOT SECURE!)', + icon=self.SHRED_ICON) + shred_1x_random_menuitem.connect('activate', self.shred_menu_activate_cb, {'cmd': shred_cmd, 'files': files}) + shred_submenu.append_item(shred_1x_random_menuitem) + + # Shred 3x overwrite, last zero's + shred_cmd = 'shred -uz' + shred_3x_zero_menuitem = Caja.MenuItem(name='ShredMenuProvider::Shred3xLastZero', + label='3x overwrite, last zero\'s', + tip=shred_cmd + ' FILE... (HDD\'s only!)', + icon=self.SHRED_ICON) + shred_3x_zero_menuitem.connect('activate', self.shred_menu_activate_cb, {'cmd': shred_cmd, 'files': files}) + shred_submenu.append_item(shred_3x_zero_menuitem) + + # Shred 3x overwrite (default) + shred_cmd = 'shred -u' + shred_3x_random_menuitem = Caja.MenuItem(name='ShredMenuProvider::Shred3x', + label='3x overwrite (Default)', + tip=shred_cmd + ' FILE... (HDD\'s only!)', + icon=self.SHRED_ICON) + shred_3x_random_menuitem.connect('activate', self.shred_menu_activate_cb, {'cmd': shred_cmd, 'files': files}) + shred_submenu.append_item(shred_3x_random_menuitem) + + return top_menuitem, + + def get_background_items(self, window, file): + wipe_zero_cmd = self.WIPE_CMD.format('zero', self.WIPE_FILENAME) + wipe_freespace_zero_menuitem = Caja.MenuItem(name='ShredMenuProvider::WipeFreespaceZero', + label='Wipe freespace zero\'s', + tip='Wipe freespace with command: "{}"'.format(wipe_zero_cmd), + icon=self.SHRED_ICON) + wipe_freespace_zero_menuitem.connect('activate', + self.wipe_freespace_menu_activate_cb, + {'cmd': wipe_zero_cmd, 'file': file}) + + wipe_random_cmd = self.WIPE_CMD.format('random', self.WIPE_FILENAME) + wipe_freespace_random_menuitem = Caja.MenuItem(name='ShredMenuProvider::WipeFreespaceRandom', + label='Wipe freespace random', + tip='Wipe freespace with command: "{}"'.format(wipe_random_cmd), + icon=self.SHRED_ICON) + wipe_freespace_random_menuitem.connect('activate', + self.wipe_freespace_menu_activate_cb, + {'cmd': wipe_random_cmd, 'file': file}) + + return wipe_freespace_zero_menuitem, wipe_freespace_random_menuitem, |