Mercurial > mozilla > hg > ProfileManager

annotate profilemanager/manager.py @ 22:956f5a4c589a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* restructure utility functions to do less more efficiently * finish remove function [untested]
author Jeff Hammel <jhammel@mozilla.com>
date Thu, 06 May 2010 15:36:00 -0700
parents 15484adb9758
children a8601c2273b5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
1 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
2 manage Mozilla/Firefox profiles
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
3 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
4
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
5 import os
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
6 import shutil
15
543d08958b67 actually sample 8 random lowercase letters and numbers for the profile hash
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
7 import string
9
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
8 import ConfigParser
15
543d08958b67 actually sample 8 random lowercase letters and numbers for the profile hash
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
9 from random import Random
5
ca57920aa223 adding better formatting for list
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
10 from utils import format_tabular
ca57920aa223 adding better formatting for list
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
11 from ConfigParser import SafeConfigParser as ConfigParser
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
12
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
13 # Changes to profiles.ini:
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
14 # - add a ``backups`` field for each profile:
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
15 # Backups = /path/to/backup:1273104310 /path/to/other/backup:1273104355
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
16
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
17 class ProfileNotFound(Exception):
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
18 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
19 exception when a profile is specified but is not present in a given
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
20 .ini file
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
21 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
22
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
23 class ProfileManager(object):
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
24
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
25 def __init__(self, profiles):
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
26 """
4
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
27 - profiles: filesystem path to profiles.ini file
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
28 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
29 self.profiles = profiles
4
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
30 self.profile_dir = os.path.abspath(os.path.dirname(profiles))
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
31
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
32 ### (public) API
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
33
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
34 def new(self, name, directory=None, hash=True):
9
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
35 """
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
36 generate a new clean profile
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
37 - name: name of the profile to generate
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
38 - directory: where to create the profile [DEFAULT: relative to profiles.ini]
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
39 - hash: whether to generate a a random hash tag
9
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
40 """
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
41
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
42 # path to the profile directory
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
43 dirname = name
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
44 relative = False
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
45 if hash:
18
8e651dd8e9ad fix two things about hash() usage
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
46 dirname = '%s.%s' % (self.hash(), dirname)
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
47 if not directory:
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
48 directory = self.profile_dir
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
49 relative = True
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
50 path = os.path.join(directory, dirname)
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
51
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
52 # create directory
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
53 # TODO: (optionally) pre-populate the directory a la FF
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
54 os.mkdir(path)
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
55
19
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
56 # update profiles.ini
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
57 parser = self.parser()
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
58 ctr = 0
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
59 section = 'Profile%d' $ ctr
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
60 while section in parser.sections():
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
61 ctr += 1
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
62 section = 'Profile%d' $ ctr
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
63 parser.add_section(self, section)
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
64 parser.set(section, 'Name', name)
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
65 parser.set(section, 'IsRelative', '%d' % int(relative))
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
66 parser.set(section, 'Path', relative and dirname or path)
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
67 if len(parser.sections()) == 1:
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
68 parser.set(section, 'Default', '1')
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
69 parser.write(self.profiles)
19
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
70
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
71 # return the directory name
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
72 return dirname
9
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
73
19
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
74 def remove(self, name, delete=True):
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
75 """
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
76 remove a profile from profiles.ini
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
77 - delete: delete the profile directory as well
19
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
78 """
21
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
79 section = self.section(name)
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
80 if section is None:
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
81 raise ProfileNotFound('Profile %s not found in %s' % (profile, self.profiles))
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
82 if delete: # remove the profile from disk
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
83 shutil.rmtree(self.path(name))
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
84 parser.remove_section(section)
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
85 parser.write(self.profiles)
19
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
86
4
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
87 def list(self, directories=False):
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
88 """
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
89 lists the profiles available in the config file
6
2a3f5cdfd60c flush out helper functions and list directories
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
90 - directories : display the directories
4
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
91 """
9
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
92 profiles = self.profiles_dict()
6
2a3f5cdfd60c flush out helper functions and list directories
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
93 retval = []
9
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
94 for name in sorted(profiles.keys()):
6
2a3f5cdfd60c flush out helper functions and list directories
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
95 values = [name]
2a3f5cdfd60c flush out helper functions and list directories
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
96 if directories:
2a3f5cdfd60c flush out helper functions and list directories
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
97 values.append(self.path(name))
2a3f5cdfd60c flush out helper functions and list directories
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
98 retval.append(values)
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
99 return format_tabular(retval) # XXX: TBD upstream
4
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
100
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
101 def clone(self, source, dest, hash=True):
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
102 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
103 clones the profile `source` and output to `dest`
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
104 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
105 source_path = self.path(source) # fs path of the `from` profile
7
d3b22d086934 comments for what to do next
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
106
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
107 # dest: fs path to back up to
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
108 relative = False
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
109 if not os.path.isabs(dest):
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
110 relative = True
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
111 if not os.path.dirname(dest):
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
112 dest = '%s.%s' % (self.hash(), dest)
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
113 dest = os.path.join(self.profile_dir, dest)
7
d3b22d086934 comments for what to do next
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
114
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
115 shutil.copytree(source_path, dest, symlinks=False)
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
116
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
117 # TODO: update profiles.ini
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
118
1
979315ed0816 mucho cleanup on optionparser stuff
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
119
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
120 def backup(self, profile, dest=None):
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
121 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
122 backup the profile
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
123 - profile: name of the profile to be backed up
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
124 - dest: name of the destination (optional)
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
125 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
126 if dest is None:
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
127 dest = '%s.%d.bak' % (profile, int(time.time()))
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
128 self.clone(profile, dest, hash=False)
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
129 # TODO: add something like
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
130 # `Backup=$(profile)s.$(datestamp)s.bak`
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
131 # to self.profiles
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
132
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
133 def backups(self, profile=None):
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
134 """
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
135 list backups for a given profile, or all profiles if the
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
136 profile is not given; returns a list of backups if
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
137 profile is given or a dictionary of lists otherwise
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
138 """
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
139 if profile is None:
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
140 # all profiles
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
141 retval = {}
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
142 return retval
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
143 # TODO
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
144
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
145 def restore(self, profile, date=None, delete=False):
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
146 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
147 restore the profile from a backup
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
148 the most recent backup is used unless `date` is given
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
149 - date : date to restore from
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
150 - delete : delete the backup after restoration
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
151 """
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
152
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
153 # get the possible backups
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
154 backups = self.backups(profile)
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
155 # TODO: check to see if these all exist (print warnings if not)
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
156
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
157 # restore the backup over ``profile``
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
158
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
159 if delete: # delete the backup
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
160 # delete the directory
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
161 # delete the entry from ``profiles.ini``
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
162 # if there are no backups, delete the ``backups`` line
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
163 pass #TODO
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
164
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
165
5
ca57920aa223 adding better formatting for list
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
166 def merge(self, output, *profiles):
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
167 """merge a set of profiles (not trivial!)"""
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
168 raise NotImplementedError
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
169
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
170 ### internal functions
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
171
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
172 def parser(self):
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
173 """
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
174 return a ConfigParser instance appropriate to profiles.ini
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
175 """
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
176 return ConfigParser().read(self.profiles)
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
177
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
178 def path(self, profile):
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
179 """returns the path to the profile"""
6
2a3f5cdfd60c flush out helper functions and list directories
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
180 profile = self.profile_dict(profile)
2a3f5cdfd60c flush out helper functions and list directories
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
181 if profile.get('isrelative', None) == '1':
2a3f5cdfd60c flush out helper functions and list directories
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
182 return os.path.join(self.profile_dir, profile['path'])
2a3f5cdfd60c flush out helper functions and list directories
Jeff Hammel <jhammel@mozilla.com>
parents: 5
diff changeset
183 return profile['path']
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
184
5
ca57920aa223 adding better formatting for list
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
185 def profile_dict(self, profile):
9
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
186 """
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
187 return option dictionary for a single profile
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
188 """
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
189 parser = self.parser()
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
190 section = self.section(profile, parser)
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
191 if section is None:
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
192 raise ProfileNotFound('Profile %s not found in %s' % (profile, self.profiles))
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
193 return dict(parser.items(section))
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
194
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
195 def section(self, profile, parser=None):
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
196 """
21
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
197 returns the name of the section that a profile is in or None
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
198 if not found
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
199 """
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
200 if parser is None:
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
201 self.parser()
21
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
202 for section in parser.section():
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
203 if not parser.has_option(section, 'name'):
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
204 continue # not a profile
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
205 if parser.get(section, 'name') == profile:
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
206 return section
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
207
9
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
208 def profiles_dict(self):
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
209 """
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
210 return nested dict of all profiles
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
211 """
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
212 # assumes profiles have unique names
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
213 parser = self.parser()
9
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
214 retval = {}
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
215 for section in parser.sections():
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
216 if section == 'General':
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
217 continue
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
218 try:
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
219 name = parser.get(section, 'name')
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
220 except ConfigParser.NoOptionError:
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
221 continue
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
222 retval[name] = self.profile_dict(name)
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
223 return retval
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
224
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
225
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
226 def hash(self):
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
227 """
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
228 generate a random hash for a new profile
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
229 """
15
543d08958b67 actually sample 8 random lowercase letters and numbers for the profile hash
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
230 population = string.lowercase + string.digits
18
8e651dd8e9ad fix two things about hash() usage
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
231 return ''.join(Random().sample(population, 8))
9
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
232
b1274abd1206 rework API a bit; the "public" methods are becoming a bit specialized to the command line, which was my fear, so I should probably inherit from ProfileManager to do the interface like I should
Jeff Hammel <jhammel@mozilla.com>
parents: 8
diff changeset
233