ownedUsbDisk.py

Aller à la documentation de ce fichier.

# -*- coding: utf-8 -*-    
#       $Id: ownedUsbDisk.py 47 2011-06-13 10:20:14Z georgesk $ 

licence={}
licence['en']="""
    file ownedUsbDisk.py
    this file is part of the project scolasync
    
    Copyright (C) 2010 Georges Khaznadar <georgesk@ofset.org>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
"""

import usbDisk2, db
import os.path, dbus, subprocess, time, random
from PyQt4.QtCore import *
from PyQt4.QtGui import *
from globaldef import markFileName

"""
liste statique pour éviter de demander chaque seconde le nom d'un
propriétaire de clé si on n'a pas souhaité le donner.
"""

##
# 
#     Renvoie le tatouage pour un point de montage donné, quitte à le créer
#     si nécessaire.
#     @param mountPoint un point de montage de partition
#     @return le tatouage
#     
def tattooInDir(mountPoint):
    tattooFileName = os.path.join(mountPoint,".scolasync-tattoo")
    tattoo_=""
    if os.path.exists(tattooFileName):
        tattoo_=open(tattooFileName,"r").readlines()[0].strip()
    if tattoo_ != "" :
        # le tatouage existe déjà, on renvoie sa valeur
        return tattoo_
    else:
        tattoo_="%12.2f" %time.time()
        time.sleep(0.05)
        # si on espace deux créations de tatouages de 50 millisecondes
        # il est impossible d'avoir deux tatouages identiques générés
        # par le même ordinateur. Les chances que ça arrive avec des
        # ordinateurs distincts sont minimes
        outfile=open(tattooFileName,"w")
        outfile.write(tattoo_)
        outfile.close()
        # on renvoie le nouveau tatouage
        return tattoo_

##
# 
#     édition de la base de données
#     @param owd une instance de ownedUsbDisk
#     @param hint chaîne vide par défaut. Peut être le nom de l'ancien propriétaire
#     
def editRecord(owd, hint=""):
    ud=owd.getFat()
    title=QApplication.translate("Dialog", "Choix du propriétaire", None, QApplication.UnicodeUTF8)
    prompt=QApplication.translate("Dialog", "Nouveau nom du propriétaire du baladeur", None, QApplication.UnicodeUTF8)
    newStudent, ok = QInputDialog.getText(None, title, prompt, text=hint)
    if ok:
        newStudent="%s" %newStudent
        assert (ud.parent) # ud est une partition de type vfat
        db.writeStudent(ud.stickid, ud.uuid, ud.tattoo(), newStudent)

##
# 
#     une classe qui ajoute un nom de propriétaire aux disque USB,
#     et qui en même temps ajoute des particularités selon le nom du
#     vendeur et le modèle.
#     
class uDisk2(usbDisk2.uDisk2,QObject):
    ##
    # 
    #         Le constructeur
    #         @param path un chemin comme '/org/freedesktop/UDisks2/block_devices/sdX'
    #         @param mp point de montage ('' par défaut)
    #         @param isUsb en général, vrai vu qu'on se s'intéressera qu'à des périphériques
    #         USB
    #         @param vendor indication de vendeur
    #         @param model indication de modèle
    #         @param parent périphérique parent (None par défaut)
    #         @param fstype type de système de fichiers
    #         @param serial numéro de série
    #         @param uuid identifiant donné au disque lors du formatage
    #         @param free taille de la zone libre pour l'écriture
    #         @param capacity taille du périphérique
    #         @param device pseudo-fichier pour l'accès au périphérique
    #         @param firstFat une instance de uDisk2, de type vfat parmi les partitions
    #         @param selected vrai/faux selon qu'on sélectionne ou non le périphérique (vrai par défaut)
    #         
    def __init__(self, path, mp='', isUsb=False, vendor='', model='', parent=None,
                 fstype='', serial='', uuid='',
                 free=0, capacity=0, device='', firstFat=None, selected=True):
        usbDisk2.uDisk2.__init__(self, path=path, mp=mp, isUsb=isUsb, vendor=vendor,
                                 model=model, parent=parent, fstype=fstype, serial=serial,
                                 uuid=uuid, free=free, capacity=capacity, device=device,
                                 firstFat=firstFat, selected=selected)
        QObject.__init__(self)
        self.owner="" # le propriétaire est déterminé plus tard
        self.visibleDirs=self.readQuirks()

    ##
    # 
    #         Renvoie le propriétaire
    #         @return le propriétaire de la clé
    #         
    def getOwner(self):
        return self.getFat().owner

    ##
    # 
    #         Renvoie à coup sûr la partition vfat d'un disque
    #         @return une instance uDisk2 représentant une partition vfat
    #         
    def getFat(self):
        if self.parent:
            return self
        else:
            return self.firstFat

    ##
    # 
    #         Facilite l'accès aux propriétés intéressantes d'une instance
    #         @return une chaîne indentée avec les propriétés intéressantes, une par ligne
    #         
    def valuableProperties(self,indent=4):
        prefix="\n"+" "*indent
        r=""
        props=["mp", "parent", "fstype", "stickid", "uuid", "vendor", "model", "devStuff", "free", "capacity", "owner"]
        for prop in props:
            r+=prefix+"%s = %s" %(prop, getattr(self,prop))
        return r

    ##
    # 
    #         @return un identifiant unique, composé du nom du propriétaire
    #         suivi du tatouage
    #         
    def uniqueId(self):
        return "%s~%s" %(self.owner, self.tattoo())

    ##
    # 
    #         Renvoie un tatouage présent sur la clé, quitte à le créer.
    #         @result un tatouage, supposément unique.
    #         
    def tattoo(self):
        ud=self.getFat()
        if ud.mp:
            return tattooInDir(ud.mp)
        else:
            return ""
    
    ##
    # 
    #         Lit un dictionnaire indexé par le noms de vendeurs et les noms de modèle
    #         pour associer à ces modèles particuliers un répertoire visible.
    #         voir la fonction visibleDir. Ce dictionnaire est dans le fichier
    #         /usr/share/scolasync/marques.py ou dans ${HOME}/.scolasync/marques.py,
    #         (sous Linux) cette dernière place étant prépondérante.
    #         
    def readQuirks (self):
        f1="/usr/share/scolasync/marques.py"
        f2=os.path.expanduser(markFileName)
        if os.path.exists(f2):
            f=f2
        else:
            f=f1
        result=eval(open(f,"r", encoding="utf-8").read())
        return result
        
    ##
    # 
    #         Renvoie le répertoire particulier de la partition qui sera visible
    #         quand le baladeur est utilisé par son interface utilisateur. Ce
    #         répertoire peut varier selon les vendeurs et les modèles.
    #         
    def visibleDir(self):
        k=self.vendor+":"+self.model
        if k in self.visibleDirs.keys():
            return self.visibleDirs[k]
        else:
            return "."

    ##
    # 
    #         Méthode statique
    #         renvoie des titres pour les items obtenus par __getitem__
    #         la deuxième colonne sera toujours le propriétaire
    #         @param locale la locale, pour traduire les titres
    #         @return une liste de titres de colonnes
    #         
    def headers(locale="C"):
        result=usbDisk2.uDisk2.headers(locale)
        ownerProp=QApplication.translate("uDisk","owner",None, QApplication.UnicodeUTF8)
        result.insert(1,ownerProp)
        return result

    ##
    # 
    #         renvoie un nom de propriétaire dans tous les cas.
    #         
    def ownerByDb(self):
        s=db.readStudent(self.stickid, self.uuid, self.tattoo())
        if s != None:
            return s
        else:
            return QApplication.translate("Dialog","inconnu",None, QApplication.UnicodeUTF8)

    ##
    # 
    #         renvoie un élément de listage de données internes au disque
    #         Fait en sorte que la deuxième colonne soit toujours le propriétaire
    #         @param n un nombre
    #         @return si n==-1, renvoie self ; renvoie un élément si n>0, et le drapeau self.selected si n==0. Les noms des éléments sont dans la liste self.itemNames
    #         
    def __getitem__(self,n):
        propListe=usbDisk2.uDisk2.headers()
        if n == -1:
            return self # pour accéder à toutes les données d'une partition
        elif n==0:
            return self.selected
        elif n==1:
            return self.ownerByDb()
        else:
            return self.unNumberProp(n)

    
    headers = staticmethod(headers)

    ##
    # 
    #         Demande un nom de propriétaire si celui-ci n'est pas encore défini
    #         pour cette clé USB. Enregistre au passage le nom du propriétaire
    #         dans les instances du disque et de sa partiton vfat
    #         @param ownerDialog si vrai : fait dialogue interactif
    #         @return un nom de propriétaire
    #         
    def ensureOwner(self, ownerDialog):
        if self.parent and not self.mp : # partiton non montée
            return
        ud=self.getFat()
        assert (ud.parent) # ud désigne une partition vfat
        if not db.knowsId(ud.stickid, ud.uuid, ud.tattoo()) :
            text=self.randomOwner(6)
            if ownerDialog:
                prompt=QApplication.translate("Dialog","La cle {id}<br>n'est pas identifiee, donnez le nom du proprietaire",None, QApplication.UnicodeUTF8).format(id=ud.stickid)
                title=QApplication.translate("Dialog","Entrer un nom",None, QApplication.UnicodeUTF8)
                text,ok = QInputDialog.getText(None, title, prompt)
            db.writeStudent(ud.stickid, ud.uuid, ud.tattoo(), text)
        o=db.readStudent(ud.stickid, ud.uuid, ud.tattoo())
        self.owner=o
        ud.owner=o
        return o

    ##
    # 
    #         fabrique un texte aléatoire de longueur donnée
    #         @param length la longueur recherchée
    #         @return un texte pseudo-aléatoire
    #         
    def randomOwner(self,length):
        result="inconnu_"
        for i in range(length):
            result+=random.choice("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789")
        return result

##
# 
#     Une classe qui fournit une collection de disques USB connectés,
#     avec leurs propriétaires. Les propriétaires sont recensés juste
#     avant le montage des partions FAT.
#     
class Available(usbDisk2.Available):

    ##
    # 
    #         Le constructeur est un proxy pour usbDisk.Available.__init__
    #         qui force la classe de disques à utiliser : en effet ici
    #         uDisk désigne ownedUsbDisk.uDisk
    #         @param access le mode d'accès : 'disk' ou 'firstFat'
    #         @param diskClass la classe d'objets à créer pour chaque disque
    #         @param ownerDialog vrai si on veut qu'il y ait un dialogue automatique
    #         pour déterminer le propriétaire des disques non reconnus
    #         
    def __init__(self, access="disk", diskClass=uDisk2, ownerDialog=False):
        self.ownerDialog=ownerDialog
        usbDisk2.Available.__init__(self, access, diskClass)
        # self.finishInit() # non! cette routine est déjà appelée par usbDisk2.Available.__init__
        
    ##
    # 
    #         Fin de l'initialisation : trouve les propriétaires des disques
    #         puis identifie les partitions FAT et les monte
    #         
    def finishInit(self):
        self.getFirstFats() # repère chaque partition FAT dans les instances des disques
        for d in self.disks_ud():
            d.owner=d.ensureOwner(self.ownerDialog)
        self.mountFirstFats()


if __name__=="__main__":
    from PyQt4.QtCore import *
    from PyQt4.QtGui import *
    import sys
    class MainWindow(QMainWindow):
        def __init__(self):
            QMainWindow.__init__(self)

            # The only thing in the app is a quit button
            quitbutton = QPushButton('Examinez le terminal\nbranchez et débranchez des clés USB, puis\nQuittez', self)
            QObject.connect(quitbutton, SIGNAL("clicked()"), self.close)
            self.setCentralWidget(quitbutton)
    
    machin=Available()
    print (machin)
    def print_targets_if_modif(man, obj):
        if machin.modified:
            print([s.split("/")[-1] for s in machin.targets.keys()])
            for t in machin.targets:
                machin.targets[t].owner=machin.targets[t].ownerByDb()
                print (machin.targets[t].owner,":", t)
        machin.modified=False
    machin.addHook('object-added',   print_targets_if_modif)
    machin.addHook('object-removed', print_targets_if_modif)
        
    app = QApplication(sys.argv)
    main = MainWindow()
    main.show()
    sys.exit(app.exec_())