Rozširovanie funkcionality súborového manažéra Nautilus pomocou vlastných skriptov

Rozhranie pre tvorbu rozšírení

Existujú dva spôsoby tvorby rozšírení pre Nautilus. Ten prvý zahŕňa využitie Nautilus API pre programátorov, ktorí môžu rozšírenie vytvoriť vo svojom obľúbenom jazyku. Ten druhý, ktorému sa budeme venovať my, umožňuje rozšírenia písať vo forme spustiteľných programov obyčajne napísaných pomocou skriptovacích jazykov. V tomto prípade si teda vystačíte iba s bash-om, ale pre komplexnejšie programátorské úlohy môžete použiť aj vyššie jazyky, ako napr. Python alebo Perl.

Výstupom týchto skriptov môže byť napr. dávkové spracovanie označených súborov (hromadné premenovanie, zmena veľkosti obrázkov a pod) alebo vykonanie špeciálnej operácie so zvoleným súborom (pripojenie ISO súboru, poslanie súboru do tlačiarne a pod.). Sú to teda operácie, ktoré nemusia mať žiadny viditeľný výstup na obrazovke. Občas však potrebujete vyriešiť aj situáciu, kedy budete od používateľa potrebovať nejaké údaje zadať, ako napr. adresu vzdialeného servera, na ktorý chcete preniesť označené súbory. V tom prípade sa hodia nástroje ako Zenity alebo KDialog, pomocou ktorých je možné vytvoriť jednoduché grafické používateľské rozhranie aj z prostredia príkazového riadku.

Píšeme prvé rozšírenie

Ako prvé rozšírenie, ktoré vytvoríme, bude jednoduchá Hello world aplikácia. To znamená, že jej reálne využitie bude síce žiadne, ale prezentujeme si na nej spôsob a postup vytvárania rozšírení pre Nautilus.

Skript reprezentujúci toto rozšírenie bude veľmi jednoduchý - vytvoríme informačné dialógové okno pomocou Zenity, v ktorom vypíšeme uvedenú správu a po kliknutí na tlačidlo OK tento dialóg zmizne. Tento skript sa nachádza vo výpise 1.

#!/bin/bash

zenity --info --text "Hello world."

Výpis 1: Rozšírenie Hello world

Každý skript, ktorým chcete Nautilus rozšíriť, je potrebné vytvoriť alebo prekopírovať do priečinku ~/.local/share/nautilus/scripts/. Teda aj nami vytvorený skript uložíme do tohto priečinku pod menom hello.sh.

Posledný zostávajúci krok je spraviť z tohto súboru spustiteľný súbor pridaním práva na spúšťanie:

chmod +x  ~/.local/share/nautilus/scripts/hello.sh

A to je všetko. Pokiaľ ste postupovali správne, po spustení programu Nautilus a kliknutí pravým tlačidlom myši na niektorý súbor, sa vám zobrazí kontextové menu s položkou Scripts, kde uvidíte nami vytvorený skript hello.sh.

Obrázok 1: Zoznam dostupných skriptov v programe Nautilus

Po kliknutí na skript sa spustí a zobrazí sa naše okno aj s príslušnou hláškou.

Obrázok 2: Výsledok spusteného skriptu.

Spustenie skriptu

Keď Nautilus spustí skript, automaticky nastaví niekoľko premenných prostredia, ktoré môžete vo svojich skriptoch následne použiť:

• NAUTILUS_SCRIPT_SELECTED_FILE_PATHS - zoznam ciest označených súborov navzájom oddelených znakom nový riadok ('\n')
• NAUTILUS_SCRIPT_SELECTED_URIS - zoznam URI označených súborov navzájom oddelených znakom nový riadok ('\n')
• NAUTILUS_SCRIPT_CURRENT_URI - aktuálne umiestnenie
• NAUTILUS_SCRIPT_WINDOW_GEOMETRY - pozícia a umiestnenie okna aplikácie Nautilus

Vo výpise 2 sa nachádza jednoduché rozšírenie, ktoré zobrazuje obsah týchto premenných. Tento skript zobrazuje hodnoty jednotlivých premenných v ich surovom tvare - ak teda označíte viacero súborov, budú od seba oddelené znakom nového riadku. Výsledok je zobrazený na obrázku 3.

#!/bin/bash

# show results
zenity --list \
    --title "Nautilus Variables" \
    --text "" \
    --column "Variable" --column "Value" \
    --width 800 --height 400 \
    '$NAUTILUS_SCRIPT_SELECTED_FILE_PATHS'  "$NAUTILUS_SCRIPT_SELECTED_FILE_PATHS" \
    '$NAUTILUS_SCRIPT_SELECTED_URIS'        "$NAUTILUS_SCRIPT_SELECTED_URIS" \
    '$NAUTILUS_SCRIPT_CURRENT_URI'          "$NAUTILUS_SCRIPT_CURRENT_URI" \
    '$NAUTILUS_SCRIPT_WINDOW_GEOMETRY'      "$NAUTILUS_SCRIPT_WINDOW_GEOMETRY"

Výpis 2: Rozšírenie Variables Info

Obrázok 2: Výsledok spusteného rozšírenia na dvoma súbormi.

Zoznam označených súborov však môže byť získaný aj podstatne tradičnejším spôsobom a to v podobe parametrov príkazového riadku skriptu. Ak teda skript vytvárame v bash-i, jedná sa o obsah premenných $@ a $*.

V nasledujúcom texte uvediem dva príklady rozšírení. V tom prvom sa bude jednať o rozšírenie pracujúce práve s jedným označeným súborom a druhý príklad bude pracovať s výberom viacerých súborov. Oba skripty budú používať pre komunikáciu s používateľom nástroj Zenity.

Príklad #1: Zistenie obsadeného miesta na disku zvoleného priečinku

Známy správca súborov TotalCommander má jednu skvelú funkciu - ak máte kurzor práve nad priečinkom a stlačíte klávesu medzerník, zistí obsadené miesto, ktoré tento priečinok zaberá na disku. Podobnú funkcionalitu má samozrejme implementovanú aj správca súborov Nautilus, kde pri zobrazení vlastností daného priečinku sa vám celkové zabrané miesto na disku zobrazí. Nie vždy je však táto informácia postačujúca, nakoľko často vás zaujíma práve to, ktorý priečinok je práve tým najväčším žrútom miesta na disku. Spravíme teda rozšírenie, ktoré po spustení nad zvoleným priečinkom zobrazí nie len informáciu o celkovom obsadení disku daným priečinkom, ale rovnako vypíše aj zoznam priečinkov a súborov nachádzajúcich sa v tomto priečinku s informáciou o ich spotrebe miesta na disku. Na získanie týchto informácií použijeme nástroj du.

Výsledný skript sa nachádza vo výpise 4. Jeho kód je rozdelený do troch častí. V tej prvej sa overí, či bol vybraný naozaj len jeden súbor a či je tento súbor priečinkom. V skripte však nie je použitá ani premenná $NAUTILUS_SCRIPT_SELECTED_FILE_PATHS ani $NAUTILUS_SCRIPT_SELECTED_URIS, ale k ceste označeného súboru sa pristupuje pomocou pozičného parametru skriptu (v tomto prípade je cesta uložená v pozičnom parametri $1). V druhej časti sa zistí, koľko miesta daný priečinok na disku zaberá spolu s jeho obsahom a v tretej časti skriptu sa výsledok zobrazí pomocou Zenity. Výsledné dialógové okno sa nachádza na obrázku 4.

#!/bin/bash

# check the number of selected files first
if [ $# -ne 1 ]; then
    zenity --error --text "Too many files selected.\nYou can select only one directory."
    exit 1
fi

# check if selected file is directory
if [ ! -d $1 ]; then
    zenity --error --text "File '$1' is not a directory."
    exit 1
fi

# run du on given directory and process result
DETAIL=$(du -hsc "$1"/* | sed -r "s/$1\///g" | sort -hr)
TOTAL=$(echo -e "$DETAIL" | head -1 | cut -f1)
DETAIL=$(echo "$DETAIL" | sed -re '1d' -e 's/\t/\n/')

# show results
zenity --list \
   --title "Disk usage of $1/" \
   --text "Disk usage of \"$1/\" is $TOTAL." \
   --column "Size" --column "Name" \
   --width 400 --height 400 \
   $DETAIL

Výpis 3: Rozšírenie Disk Space Usage

Obrázok 4: Dialógové okno rozšírenia Disk Space Usage po sputení nad priečinkom _edu.

Príklad #2: Premenovanie Jpeg súborov na základe ich dátumu a času vytvorenia

Ak fotíte, tak to poznáte - každý digitálny fotoaparát alebo zariadenie, s ktorým je možné vytvárať fotografie, si pomenovávanie súborov rieši po svojom. Obyčajne sa jedná o nejaký prefix, za ktorým nasleduje poradové číslo fotografie. Ak sa snažíte riešiť manažment fotografií ručne bez použitia nástrojov ako Shotwell, užijete si dosť zábavy (hlavne v prípadoch, ak fotíte až do zaplnenia karty, čo môže trvať aj niekoľko mesiacov).

Toto rozšírenie teda pomôže vyriešiť túto situáciu - v Nautiluse označíte súbory typu Jpeg a z ich metaúdajov (EXIF) sa získa informácia o čase a dátume vytvorenia fotografie. Tieto sa následne použijú na zostavenie nového názvu súboru a dôjde k premenovaniu. Dátum a čas vytvorenia fotografie sa získa pomocou nástroja exiftool. V prípade, ak používateľ označí súbory, z ktorého exiftool nebude vedieť získať potrebné údaje, zobrazí ich na konci vykonanej operácie v chybovom dialógovom okne.

Samotný skript sa nachádza vo výpise 4. Pre celkovú jednoduchosť obsahuje len základnú funkcionalitu a poskytuje teda dostatok možností na jeho ďalšie rozširovanie (napr. zobrazovanie priebehu premenovávania alebo kontrola, či súbor s rovnakým názvom už neexistuje (to sa môže stať v prípade, ak vznikla séria fotografií fotených veľmi rýchlo za sebou)). V tomto prípade neobsahuje ani kontrolu počtu vstupných parametrov, nakoľko pokiaľ neoznačíte žiadny súbor, v kontextovom menu položku s vašimi skriptami nenájdete. O svoje prípadné úpravy a rozšírenia sa môžete podeliť v diskusii pod článkom. Ani v tomto prípade som však nepoužil ani jednu z premenných, ktoré boli súborovým správcom Nautilus nastavené. Opäť som si vystačil s premennou $@, v ktorej sa nachádza zoznam označených súborov.

#!/bin/bash

ERRORS=""   # list of errors
IFS=""      # input field separator

# process selected files
for FILE in $@; do
    if [ -f "$FILE" ]; then
        DATETIME=$(exiftool -d "%Y%m%d_%H%M%S" -DateTimeOriginal -S -s "$FILE")
        if [ ! -z "$DATETIME" ]; then
            mv "$FILE" "$DATETIME.jpg"
        else
            ERRORS="$ERRORS\n'$FILE' doesn't contain original datetime data."
        fi
    else
        ERRORS="$ERRORS\n'$FILE' is not regular file."
    fi
done

# if list of errors is not empty, show them
if [ ! -z "$ERRORS" ]; then
    zenity --error --text "$ERRORS"
fi

Výpis 4: Rozšírenie Exif Rename

Záver

Tvorba rozšírení pre správcu súborov Nautilus v bash-i je veľmi jednoduchá aj napriek niektorým obmedzeniam, ktorý tento vývoj obnáša. V odkazoch pod článkom nájdete niekoľko odkazov na ďalšie návody alebo priamo na hotové rozšírenia. Ale väčšiu výzvu predstavuje vytvorenie vlastného rozšírenia na vyriešenie vlastného problému. Tak do toho!

Použité zdroje

1. GNOME Files - https://en.wikipedia.org/wiki/GNOME_Files
2. Nautilus Scripts Howto - https://help.ubuntu.com/community/NautilusScriptsHowto
3. Nautilus Scripts - http://g-scripts.sourceforge.net/
4. A collection of Nautilus scripts - http://mundogeek.net/nautilus-scripts/
5. Zoznam príkladov pre KDialog - https://mostlylinux.wordpress.com/bashscripting/kdialog/
6. Príručka k aplikácii Zenity - https://help.gnome.org/users/zenity/stable/
7. Kompletné príklady pre Zenity - http://linux.byexamples.com/archives/259/a-complete-zenity-dialog-examples-1/
8. Tvorba rozšírení pre Nautilus v jazyku C - http://web.archive.org/web/20090418175132/http://www.campd.org/stuff/docs/extending-nautilus/NautilusExtensions.html
9. Referenčná príručka pre písanie rozšírení pre Nautilus v jazyku Python - https://projects-old.gnome.org/nautilus-python/documentation/html/index.html
10. Exchangeable image file format - https://en.wikipedia.org/wiki/Exchangeable_image_file_format
11. Streamline Your Workflow With These Nifty Nautilus Scripts - http://www.omgubuntu.co.uk/2016/07/useful-pack-nautilus-scripts