Mercurial > mozilla > hg > ProfileManager

annotate profilemanager/manager.py @ 75:a63dd19807c8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* actually write the file * dont fatally err if a backup isnt actually there
author Jeff Hammel <jhammel@mozilla.com>
date Fri, 07 May 2010 17:20:13 -0700
parents b6bb59b79525
children e091caa41075
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
75
a63dd19807c8 * actually write the file
Jeff Hammel <jhammel@mozilla.com>
parents: 74
diff changeset
8 import sys
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
9 import tempfile
50
4cd6fc940407 * test backup
Jeff Hammel <jhammel@mozilla.com>
parents: 48
diff changeset
10 import time
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
11 import ConfigParser
65
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
12 from datetime import datetime
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
13 from dateutil.parser import parse
15
543d08958b67 actually sample 8 random lowercase letters and numbers for the profile hash
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
14 from random import Random
5
ca57920aa223 adding better formatting for list
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
15 from utils import format_tabular
ca57920aa223 adding better formatting for list
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
16 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
17
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
18 # Changes to profiles.ini:
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
19 # - add a ``backups`` field for each profile:
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
20 # 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
21
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
22 class ProfileNotFound(Exception):
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
23 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
24 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
25 .ini file
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
26 """
47
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
27 def __init__(self, profile, config):
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
28 self.profile = profile
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
29 self.config = config
57
3b4b87faa2a8 * make options case-sensitive
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
30 Exception.__init__(self,
3b4b87faa2a8 * make options case-sensitive
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
31 'Profile %s not found in %s' % (profile, config))
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
32
65
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
33 class NoBackupError(Exception):
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
34 """
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
35 exception when a sought backup is not found
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
36 """
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
37
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
38 class ProfileManager(object):
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
39
47
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
40 backups_dir = 'backups' # directory for backups relative to profile_dir
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
41
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
42 def __init__(self, profiles):
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
43 """
4
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
44 - 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
45 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
46 self.profiles = profiles
4
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
47 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
48
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
49 ### (public) API
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
50
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
51 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
52 """
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
53 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
54 - name: name of the profile to generate
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
55 - 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
56 - 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
57 """
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
58
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
59 # path to the profile directory
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
60 dirname = name
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
61 relative = False
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
62 if hash:
18
8e651dd8e9ad fix two things about hash() usage
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
63 dirname = '%s.%s' % (self.hash(), dirname)
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
64 if not directory:
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
65 directory = self.profile_dir
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
66 relative = True
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
67 path = os.path.join(directory, dirname)
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
68
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
69 # create directory
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
70 # TODO: (optionally) pre-populate the directory a la Firefox
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
71 os.mkdir(path)
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
72
19
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
73 # update profiles.ini
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
74 self.add(name, relative and dirname or path, relative)
19
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
75
16
c80d44e5ca41 flush out new() function
Jeff Hammel <jhammel@mozilla.com>
parents: 15
diff changeset
76 # return the directory name
36
a6222b71aab6 return the right thing, finally
Jeff Hammel <jhammel@mozilla.com>
parents: 31
diff changeset
77 return path
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
78
19
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
79 def remove(self, name, delete=True):
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
80 """
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
81 remove a profile from profiles.ini
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
82 - delete: delete the profile directory as well
19
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
83 """
37
76fc1a23182c instantiate a parser
Jeff Hammel <jhammel@mozilla.com>
parents: 36
diff changeset
84 parser = self.parser()
76fc1a23182c instantiate a parser
Jeff Hammel <jhammel@mozilla.com>
parents: 36
diff changeset
85 section = self.section(name, parser)
21
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
86 if section is None:
47
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
87 raise ProfileNotFound(profile, self.profiles)
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
88 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
89 shutil.rmtree(self.path(name))
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
90 parser.remove_section(section)
51
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
91 self.write(parser)
19
4a1815f8d146 * stub adding new profile to configuration
Jeff Hammel <jhammel@mozilla.com>
parents: 18
diff changeset
92
4
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
93 def list(self, directories=False):
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
94 """
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
95 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
96 - directories : display the directories
4
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
97 """
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
98 profiles = self.profiles_dict()
38
81500171fda8 change output format
Jeff Hammel <jhammel@mozilla.com>
parents: 37
diff changeset
99 if not directories:
81500171fda8 change output format
Jeff Hammel <jhammel@mozilla.com>
parents: 37
diff changeset
100 return sorted(profiles.keys())
81500171fda8 change output format
Jeff Hammel <jhammel@mozilla.com>
parents: 37
diff changeset
101 return dict([(name, self.path(name)) for name in profiles.keys()])
4
35dc297efa25 adding listing function and other cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 3
diff changeset
102
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
103 def clone(self, source, dest, add=True):
0
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 clones the profile `source` and output to `dest`
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
106 - add: add the profile to the profiles.ini file
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
107 """
45
6feee8d04db4 even more cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 43
diff changeset
108
6feee8d04db4 even more cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 43
diff changeset
109 # filesystem path of the `from` profile
6feee8d04db4 even more cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 43
diff changeset
110 source_path = self.path(source)
7
d3b22d086934 comments for what to do next
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
111
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
112 # 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
113 relative = False
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
114 if os.path.sep in dest:
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
115 if not os.path.isabs(dest):
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
116 dest = os.path.abspath(dest)
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
117 dirname = dest
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
118 name = os.path.basename(dest)
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
119 else:
46
df1b2e48dddb handle hashing for clones only if they are added to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
120 name = dest
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
121 relative = True
46
df1b2e48dddb handle hashing for clones only if they are added to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
122 if add:
df1b2e48dddb handle hashing for clones only if they are added to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
123 dirname = '%s.%s' % (self.hash(), name)
48
09a2666999fa * restore profiles.ini to base in tests
Jeff Hammel <jhammel@mozilla.com>
parents: 47
diff changeset
124 dest = os.path.join(self.profile_dir, dirname)
7
d3b22d086934 comments for what to do next
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
125
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
126 # update profiles.ini
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
127 if add:
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
128 self.add(name, dirname, relative)
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
129
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
130 # copy the files
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
131 shutil.copytree(source_path, dest, symlinks=False)
43
49cc40572f46 test cloning
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
132
49cc40572f46 test cloning
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
133 return dest
1
979315ed0816 mucho cleanup on optionparser stuff
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
134
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
135 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
136 """
56
2dde7dcc899e better docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
137 backup a profile
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
138 - profile: name of the profile to be backed up
56
2dde7dcc899e better docstring
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
139 - dest: name of the destination; if not given, a default is used
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
140 """
47
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
141
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
142 # get the profile section
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
143 parser = self.parser()
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
144 section = self.section(profile)
58
ce6a101fb239 check for section; of course profile will not be none
Jeff Hammel <jhammel@mozilla.com>
parents: 57
diff changeset
145 if section is None:
47
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
146 raise ProfileNotFound(profile, self.profiles)
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
147
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
148 # determine destination directory
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
149 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
150 dest = '%s.%d.bak' % (profile, int(time.time()))
47
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
151 name = dest
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
152 backups_dir = os.path.join(self.profile_dir, self.backups_dir)
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
153 if not os.path.exists(backups_dir):
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
154 os.mkdir(backups_dir)
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
155 dest = os.path.join(backups_dir, dest)
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
156 else:
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
157 if not os.path.isabs(dest):
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
158 dest = os.path.abspath(dest)
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
159 name = dest
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
160
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
161 # copy the files
45
6feee8d04db4 even more cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 43
diff changeset
162 self.clone(profile, dest, add=False)
47
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
163
51
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
164 # add backup entry to profiles.ini (colon separated):
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
165 # `Backup=$(profile)s.$(datestamp)s.bak`
51
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
166 if parser.has_option(section, 'Backups'):
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
167 backups = '%s:%s' % (parser.get(section, 'Backups'), name)
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
168 else:
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
169 backups = name
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
170 parser.set(section, 'Backups', backups)
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
171 self.write(parser)
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
172
52
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
173 def backups(self, profile=None, datestamp=None):
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
174 """
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
175 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
176 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
177 profile is given or a dictionary of lists otherwise
53
c279d2797d45 document datestamp argument
Jeff Hammel <jhammel@mozilla.com>
parents: 52
diff changeset
178 - datestamp: format of date; otherwise, seconds since epoch
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
179 """
52
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
180 if profile is None: # all profiles
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
181 retval = {}
52
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
182 profiles_dict = self.profiles_dict()
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
183 for profile in profiles_dict:
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
184 if 'Backups' in profiles_dict[profile]:
64
18f16bd1ba6b finish backups listing function and formatting for it
Jeff Hammel <jhammel@mozilla.com>
parents: 63
diff changeset
185 retval[profile] = self.backups(profile, datestamp)
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
186 return retval
52
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
187
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
188 # single profile
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
189 profile_dict = self.profile_dict(profile)
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
190 if 'Backups' not in profile_dict:
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
191 return []
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
192 backups = profile_dict['Backups'].split(':')
63
2f58555b3b28 correct variable names
Jeff Hammel <jhammel@mozilla.com>
parents: 62
diff changeset
193 backups_dirs = []
52
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
194 for backup in backups:
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
195 if os.path.isabs(backup):
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
196 backup_dir = backup
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
197 else:
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
198 backup_dir = os.path.join(self.profile_dir, self.backups_dir, backup)
75
a63dd19807c8 * actually write the file
Jeff Hammel <jhammel@mozilla.com>
parents: 74
diff changeset
199 try:
a63dd19807c8 * actually write the file
Jeff Hammel <jhammel@mozilla.com>
parents: 74
diff changeset
200 backups_dirs.append((backup, int(os.path.getmtime(backup_dir))))
a63dd19807c8 * actually write the file
Jeff Hammel <jhammel@mozilla.com>
parents: 74
diff changeset
201 except OSError:
a63dd19807c8 * actually write the file
Jeff Hammel <jhammel@mozilla.com>
parents: 74
diff changeset
202 print >> sys.stderr, "%s specified in %s, but the directory %s does not exist" % (backup, self.profiles, backup_dir)
52
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
203 # TODO: check if the getmtime == the datestamp for relative backups
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
204
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
205 # sort by reverse datestamp
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
206 backups_dirs.sort(key=lambda x: x[1], reverse=True)
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
207
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
208 # format to datestamps, if applicable
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
209 if datestamp:
63
2f58555b3b28 correct variable names
Jeff Hammel <jhammel@mozilla.com>
parents: 62
diff changeset
210 backups_dirs = [ (i[0], time.strftime(datestamp,
52
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
211 time.localtime(int(i[1]))))
63
2f58555b3b28 correct variable names
Jeff Hammel <jhammel@mozilla.com>
parents: 62
diff changeset
212 for i in backups_dirs ]
52
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
213
85b5fe402ab4 finish backups functionality (to test)
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
214 return backups_dirs
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
215
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
216 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
217 """
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
218 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
219 the most recent backup is used unless `date` is given
65
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
220 - date : date to restore from (will not delete)
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
221 - 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
222 """
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
223
65
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
224 assert not (date and delete), 'date and delete cannot be used in conjunction'
73
1cfd259f74cf finish dated backups, untested
Jeff Hammel <jhammel@mozilla.com>
parents: 71
diff changeset
225 orig_date = date
65
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
226
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
227 # get the path to the profile
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
228 path = self.path(profile)
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
229
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
230 # get the possible backups
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
231 backups = self.backups(profile)
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
232 # 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
233
65
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
234 # determine the backup to use
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
235 if date:
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
236
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
237 if isinstance(date, basestring):
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
238
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
239 # test for s since epoch
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
240 seconds_snice_epoch = None
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
241 try:
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
242 seconds_since_epoch = int(date)
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
243
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
244 except ValueError:
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
245 pass
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
246 if seconds_since_epoch and seconds_since_epoch > time.localtime().tm_year:
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
247 date = seconds_since_epoch
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
248 else:
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
249 date = parse(date) # parse date from string
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
250
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
251 if isinstance(date, datetime):
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
252 # convert to s since epoch
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
253 date = time.mktime(date.timetuple())
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
254
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
255 for backup in backups:
73
1cfd259f74cf finish dated backups, untested
Jeff Hammel <jhammel@mozilla.com>
parents: 71
diff changeset
256 if backup[1] < date:
1cfd259f74cf finish dated backups, untested
Jeff Hammel <jhammel@mozilla.com>
parents: 71
diff changeset
257 break
1cfd259f74cf finish dated backups, untested
Jeff Hammel <jhammel@mozilla.com>
parents: 71
diff changeset
258 else:
1cfd259f74cf finish dated backups, untested
Jeff Hammel <jhammel@mozilla.com>
parents: 71
diff changeset
259 raise NoBackupError("No backups for profile %s in %s earlier than %s" % (profile, self.profiles, orig_date))
65
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
260 else:
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
261 if not backups:
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
262 raise NoBackupError("No backups for profile %s in %s" % (profile, self.profiles))
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
263 backup = backups[0]
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
264
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
265 # determine path of the backup
67
7da81d5545a2 missing :
Jeff Hammel <jhammel@mozilla.com>
parents: 66
diff changeset
266 if os.path.isabs(backup[0]):
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
267 backup_path = backup
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
268 else:
69
86b137d49467 use only the path element, not the whole tuple
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
269 backup_path = os.path.join(self.profile_dir, self.backups_dir, backup[0])
65
1cd3e3c71bff determine which backup to use from the given date
Jeff Hammel <jhammel@mozilla.com>
parents: 64
diff changeset
270
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
271 # restore the backup over ``profile``
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
272 # make a backup copy first to avoid data loss
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
273 tempdir = tempfile.mktemp()
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
274 shutil.move(path, tempdir)
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
275 try:
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
276 shutil.copytree(backup_path, path)
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
277 except Exception, e:
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
278 shutil.rmtree(path)
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
279 shutil.move(tempdir, path)
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
280 raise IOError("Couldn't restore backup: %s" % str(e))
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
281 shutil.rmtree(tempdir)
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
282 # TODO: (optionally) make a backup of the current profile before restore
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
283
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
284 if delete: # delete the backup
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
285
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
286 # delete the directory
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
287 shutil.rmtree(backup_path)
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
288
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
289 # delete the entry from ``profiles.ini``
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
290 parser = self.parser()
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
291 section = self.section(profile)
70
6e282cacd5f0 split the string
Jeff Hammel <jhammel@mozilla.com>
parents: 69
diff changeset
292 backups = parser.get(section, 'Backups').split(':')
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
293 backups = [ i for i in backups if i != backup[0] ]
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
294 parser.set(section, 'Backups', ':'.join(backups))
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
295
10
c77e9bef78d6 * update list of public API functions
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
296 # if there are no backups, delete the ``backups`` line
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
297 # and the backups directory
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
298 if not backups:
71
494ea3c2f578 use correct ConfigParser method
Jeff Hammel <jhammel@mozilla.com>
parents: 70
diff changeset
299 parser.remove_option(section, 'Backups')
66
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
300 backups_dir = os.path.join(self.profile_dir, self.backups_dir)
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
301 if not os.listdir(backups_dir):
67dc95a355cc finish basic restore logic
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
302 shutil.rmtree(backups_dir)
47
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
303
75
a63dd19807c8 * actually write the file
Jeff Hammel <jhammel@mozilla.com>
parents: 74
diff changeset
304 self.write(parser)
a63dd19807c8 * actually write the file
Jeff Hammel <jhammel@mozilla.com>
parents: 74
diff changeset
305
74
b6bb59b79525 * return the backed-up profile
Jeff Hammel <jhammel@mozilla.com>
parents: 73
diff changeset
306 # return which backup is restored
b6bb59b79525 * return the backed-up profile
Jeff Hammel <jhammel@mozilla.com>
parents: 73
diff changeset
307 return backup
b6bb59b79525 * return the backed-up profile
Jeff Hammel <jhammel@mozilla.com>
parents: 73
diff changeset
308
47
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
309 def temporary(self):
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
310 """make a temporary profile"""
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
311 raise NotImplementedError
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
312
5
ca57920aa223 adding better formatting for list
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
313 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
314 """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
315 raise NotImplementedError
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
316
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
317 ### internal functions
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
318
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
319 def add(self, profile, path, relative=True):
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
320 """
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
321 add a profile entry to profiles.ini
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
322 """
41
769447f8cd08 cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 40
diff changeset
323
769447f8cd08 cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 40
diff changeset
324 # ensure name is not already present
769447f8cd08 cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 40
diff changeset
325 assert profile not in self.profiles_dict(), 'Profile "%s" already in %s' % (name, self.profiles)
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
326 parser = self.parser()
41
769447f8cd08 cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 40
diff changeset
327
769447f8cd08 cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 40
diff changeset
328 # find and add the section
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
329 ctr = 0
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
330 section = 'Profile%d' % ctr # unsure of this naming convention
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
331 while section in parser.sections():
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
332 ctr += 1
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
333 section = 'Profile%d' % ctr
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
334 parser.add_section(section)
41
769447f8cd08 cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 40
diff changeset
335
769447f8cd08 cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 40
diff changeset
336 # add metadata
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
337 parser.set(section, 'Name', profile)
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
338 parser.set(section, 'IsRelative', '%d' % int(relative))
42
232188e7c04c more cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 41
diff changeset
339 parser.set(section, 'Path', path)
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
340 if not ctr:
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
341 parser.set(section, 'Default', '1')
41
769447f8cd08 cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 40
diff changeset
342
769447f8cd08 cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 40
diff changeset
343 # write the file
51
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
344 self.write(parser)
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
345
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
346 def path(self, profile):
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
347 """returns the path to the profile"""
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
348 profile = self.profile_dict(profile)
62
e29fed5097c3 more case corrections
Jeff Hammel <jhammel@mozilla.com>
parents: 61
diff changeset
349 if profile.get('IsRelative', None) == '1':
e29fed5097c3 more case corrections
Jeff Hammel <jhammel@mozilla.com>
parents: 61
diff changeset
350 return os.path.join(self.profile_dir, profile['Path'])
e29fed5097c3 more case corrections
Jeff Hammel <jhammel@mozilla.com>
parents: 61
diff changeset
351 return profile['Path']
40
34c740d1962d abstract out adding an entry to profiles.ini
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
352
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
353 def parser(self):
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
354 """
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
355 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
356 """
25
fc31d3f26755 i seriously need to learn to code
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
357 parser = ConfigParser()
57
3b4b87faa2a8 * make options case-sensitive
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
358 parser.optionxform = str
25
fc31d3f26755 i seriously need to learn to code
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
359 parser.read(self.profiles)
fc31d3f26755 i seriously need to learn to code
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
360 return parser
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
361
51
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
362 def write(self, parser):
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
363 f = file(self.profiles, 'w')
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
364 parser.write(f)
dc9324b52c2a * add write convenience function
Jeff Hammel <jhammel@mozilla.com>
parents: 50
diff changeset
365 f.close()
0
7301d534bc6c initial messy and incomplete strawman prototype for Mozilla (Firefox) profile management
Jeff Hammel <k0scist@gmail.com>
parents:
diff changeset
366
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
367 def section(self, profile, parser=None):
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
368 """
21
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
369 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
370 if not found
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
371 """
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
372 if parser is None:
29
105ecbac0928 fix some test failures
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
373 parser = self.parser()
31
216a74146d16 sections, plural
Jeff Hammel <jhammel@mozilla.com>
parents: 30
diff changeset
374 for section in parser.sections():
61
24782e4c70ca now that we are case sensitive, correct case for getting options
Jeff Hammel <jhammel@mozilla.com>
parents: 59
diff changeset
375 if not parser.has_option(section, 'Name'):
21
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
376 continue # not a profile
61
24782e4c70ca now that we are case sensitive, correct case for getting options
Jeff Hammel <jhammel@mozilla.com>
parents: 59
diff changeset
377 if parser.get(section, 'Name') == profile:
21
15484adb9758 note what section a a profile is in
Jeff Hammel <jhammel@mozilla.com>
parents: 20
diff changeset
378 return section
20
49d523a33c89 more stubbing
Jeff Hammel <jhammel@mozilla.com>
parents: 19
diff changeset
379
27
5988a15da3b4 things are being awful; checking in anyway
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
380 def profile_dict(self, profile):
5988a15da3b4 things are being awful; checking in anyway
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
381 """
5988a15da3b4 things are being awful; checking in anyway
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
382 return option dictionary for a single profile
5988a15da3b4 things are being awful; checking in anyway
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
383 """
5988a15da3b4 things are being awful; checking in anyway
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
384 parser = self.parser()
5988a15da3b4 things are being awful; checking in anyway
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
385 section = self.section(profile, parser)
5988a15da3b4 things are being awful; checking in anyway
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
386 if section is None:
47
420becb84df7 * move exception string to the exception itself
Jeff Hammel <jhammel@mozilla.com>
parents: 46
diff changeset
387 raise ProfileNotFound(profile, self.profiles)
27
5988a15da3b4 things are being awful; checking in anyway
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
388 return dict(parser.items(section))
5988a15da3b4 things are being awful; checking in anyway
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
389
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
390 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
391 """
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
392 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
393 """
22
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
394 # assumes profiles have unique names
956f5a4c589a * restructure utility functions to do less more efficiently
Jeff Hammel <jhammel@mozilla.com>
parents: 21
diff changeset
395 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
396 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
397 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
398 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
399 continue
59
ee2777913a9e check the correct way to see if the option is there
Jeff Hammel <jhammel@mozilla.com>
parents: 58
diff changeset
400 if not parser.has_option(section, 'Name'):
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
401 continue
61
24782e4c70ca now that we are case sensitive, correct case for getting options
Jeff Hammel <jhammel@mozilla.com>
parents: 59
diff changeset
402 name = parser.get(section, 'Name')
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
403 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
404 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
405
8
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
406 def hash(self):
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
407 """
7205cb6f5530 various flushing out, deleting old TODOs and making new ones
Jeff Hammel <jhammel@mozilla.com>
parents: 7
diff changeset
408 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
409 """
15
543d08958b67 actually sample 8 random lowercase letters and numbers for the profile hash
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
410 population = string.lowercase + string.digits
18
8e651dd8e9ad fix two things about hash() usage
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
411 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
412
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
413