1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
|
# Back In Time
# Copyright (C) 2008-2009 Oprea Dan
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import os.path
import os
import datetime
import gettext
import configfile
import tools
_=gettext.gettext
gettext.bindtextdomain( 'backintime', '/usr/share/locale' )
gettext.textdomain( 'backintime' )
class Config( configfile.ConfigFile ):
APP_NAME = 'Back In Time'
VERSION = '0.9.26'
COPYRIGHT = 'Copyright (c) 2008-2009 Oprea Dan'
CONFIG_VERSION = 2
NONE = 0
_5_MIN = 2
_10_MIN = 4
HOUR = 10
DAY = 20
WEEK = 30
MONTH = 40
YEAR = 80
DISK_UNIT_MB = 10
DISK_UNIT_GB = 20
AUTOMATIC_BACKUP_MODES = {
NONE : _('Disabled'),
_5_MIN: _('Every 5 minutes'),
_10_MIN: _('Every 10 minutes'),
HOUR : _('Every Hour'),
DAY : _('Every Day'),
WEEK : _('Every Week'),
MONTH : _('Every Month')
}
REMOVE_OLD_BACKUP_UNITS = {
DAY : _('Day(s)'),
WEEK : _('Week(s)'),
YEAR : _('Year(s)')
}
MIN_FREE_SPACE_UNITS = { DISK_UNIT_MB : 'Mb', DISK_UNIT_GB : 'Gb' }
def __init__( self ):
self._APP_PATH = os.path.dirname( os.path.abspath( os.path.dirname( __file__ ) ) )
self._DOC_PATH = '/usr/share/doc/backintime'
if os.path.exists( os.path.join( self._APP_PATH, 'LICENSE' ) ):
self._DOC_PATH = self._APP_PATH
self._GLOBAL_CONFIG_PATH = '/etc/backintime/config'
HOME_FOLDER = os.path.expanduser( '~' )
self._LOCAL_DATA_FOLDER = os.path.join( os.getenv( 'XDG_DATA_HOME', '$HOME/.local/share' ).replace( '$HOME', HOME_FOLDER ), 'backintime' )
self._LOCAL_CONFIG_FOLDER = os.path.join( os.getenv( 'XDG_CONFIG_HOME', '$HOME/.config' ).replace( '$HOME', HOME_FOLDER ), 'backintime' )
#self._LOCAL_CONFIG_FOLDER = os.path.expanduser( '~/.config/backintime' )
tools.make_dirs( self._LOCAL_CONFIG_FOLDER )
tools.make_dirs( self._LOCAL_DATA_FOLDER )
self._LOCAL_CONFIG_PATH = os.path.join( self._LOCAL_CONFIG_FOLDER, 'config' )
old_path = os.path.join( self._LOCAL_CONFIG_FOLDER, 'config2' )
if os.path.exists( old_path ):
if os.path.exists( self._LOCAL_CONFIG_PATH ):
os.system( "rm \"%s\"" % old_path )
else:
os.system( "mv \"%s\" \"%s\"" % ( old_path, self._LOCAL_CONFIG_PATH ) )
self.load( self._GLOBAL_CONFIG_PATH )
self.append( self._LOCAL_CONFIG_PATH )
if self.get_int_value( 'config.version', 1 ) < 2:
#remap old items
self.remap_key( 'BASE_BACKUP_PATH', 'snapshots.path' )
self.remap_key( 'INCLUDE_FOLDERS', 'snapshots.include_folders' )
self.remap_key( 'EXCLUDE_PATTERNS', 'snapshots.exclude_patterns' )
self.remap_key( 'AUTOMATIC_BACKUP', 'snapshots.automatic_backup_mode' )
self.remap_key( 'REMOVE_OLD_BACKUPS', 'snapshots.remove_old_snapshots.enabled' )
self.remap_key( 'REMOVE_OLD_BACKUPS_VALUE', 'snapshots.remove_old_snapshots.value' )
self.remap_key( 'REMOVE_OLD_BACKUPS_UNIT', 'snapshots.remove_old_snapshots.unit' )
self.remap_key( 'MIN_FREE_SPACE', 'snapshots.min_free_space.enabled' )
self.remap_key( 'MIN_FREE_SPACE_VALUE', 'snapshots.min_free_space.value' )
self.remap_key( 'MIN_FREE_SPACE_UNIT', 'snapshots.min_free_space.unit' )
self.remap_key( 'DONT_REMOVE_NAMED_SNAPSHOTS', 'snapshots.dont_remove_named_snapshots' )
self.remap_key( 'DIFF_CMD', 'gnome.diff.cmd' )
self.remap_key( 'DIFF_CMD_PARAMS', 'gnome.diff.params' )
self.remap_key( 'LAST_PATH', 'gnome.last_path' )
self.remap_key( 'MAIN_WINDOW_X', 'gnome.main_window.x' )
self.remap_key( 'MAIN_WINDOW_Y', 'gnome.main_window.y' )
self.remap_key( 'MAIN_WINDOW_WIDTH', 'gnome.main_window.width' )
self.remap_key( 'MAIN_WINDOW_HEIGHT', 'gnome.main_window.height' )
self.remap_key( 'MAIN_WINDOW_HPANED1_POSITION', 'gnome.main_window.hpaned1' )
self.remap_key( 'MAIN_WINDOW_HPANED2_POSITION', 'gnome.main_window.hpaned2' )
if self.get_int_value( 'config.version', 1 ) < self.CONFIG_VERSION:
self.set_int_value( 'config.version', self.CONFIG_VERSION )
def save( self ):
configfile.ConfigFile.save( self, self._LOCAL_CONFIG_PATH )
def check_take_snapshot_params( self, snapshots_path, include_list, exclude_list ):
#returns None or ( ID, message ) //0 - snapshots path, 1 - include list, 2 - exclude list
if len( snapshots_path ) == 0 or not os.path.isdir( snapshots_path ):
return ( 0, _('Snapshots folder is not valid !') )
if len( snapshots_path ) <= 1:
return ( 0, _('Snapshots folder can\'t be the root folder !') )
if len( include_list ) <= 0:
return ( 1, _('You must select at least one folder to backup !') )
snapshots_path2 = snapshots_path + '/'
for item in include_list:
path = item[0]
if path == snapshots_path:
print "Path: " + path
print "SnapshotsPath: " + snapshots_path
return ( 1, _('You can\'t include backup folder !') )
if len( path ) >= len( snapshots_path2 ):
if path[ : len( snapshots_path2 ) ] == snapshots_path2:
print "Path: " + path
print "SnapshotsPath2: " + snapshots_path2
return ( 1, _('You can\'t include a backup sub-folder !') )
#else:
# path2 = path + '/'
# if len( path2 ) < len( snapshots_path ):
# if path2 == snapshots_path[ : len( path2 ) ]:
# print "Path2: " + path2
# print "SnapshotsPath: " + snapshots_path
# return ( 1, _('"Backup folders" can\'t include snapshots folder !') )
for exclude in exclude_list:
if exclude.find( ':' ) >= 0:
return ( 2, _('Exclude patterns can\'t contain \':\' char !') )
return None
def get_snapshots_path( self ):
return self.get_str_value( 'snapshots.path', '' )
def get_snapshots_full_path( self ):
return os.path.join( self.get_snapshots_path(), 'backintime' )
def set_snapshots_path( self, value ):
print "Snapshots path: %s" % value
if len( value ) > 0:
if not os.path.isdir( value ):
return _( '%s is not a folder !' ) % value
else:
old_value = self.get_snapshots_path()
self.set_str_value( 'snapshots.path', value )
full_path = self.get_snapshots_full_path()
self.set_str_value( 'snapshots.path', old_value )
if not os.path.isdir( full_path ):
tools.make_dirs( full_path )
if not os.path.isdir( full_path ):
return _( 'Can\'t write to: %s\nAre you sure have write access ?' ) % value
self.set_str_value( 'snapshots.path', value )
return None
def get_include_folders( self ):
value = self.get_str_value( 'snapshots.include_folders', '' )
if len( value ) <= 0:
return []
paths = []
for item in value.split(':'):
fields = item.split( '|' )
path = os.path.expanduser( fields[0] )
path = os.path.abspath( path )
if len( fields ) >= 2:
automatic_backup_mode = int( fields[1] )
else:
automatic_backup_mode = self.get_automatic_backup_mode()
paths.append( ( path, automatic_backup_mode ) )
return paths
def set_include_folders( self, list ):
value = ''
for item in list:
if len( value ) > 0:
value = value + ':'
value = value + item[0] + '|' + str( item[1] )
self.set_str_value( 'snapshots.include_folders', value )
def get_exclude_patterns( self ):
value = self.get_str_value( 'snapshots.exclude_patterns', '.*:*.backup*:*~' )
if len( value ) <= 0:
return []
return value.split(':')
def set_exclude_patterns( self, list ):
self.set_str_value( 'snapshots.exclude_patterns', ':'.join( list ) )
def get_automatic_backup_mode( self ):
return self.get_int_value( 'snapshots.automatic_backup_mode', self.NONE )
def set_automatic_backup_mode( self, value ):
self.set_int_value( 'snapshots.automatic_backup_mode', value )
#self.setup_cron()
def get_per_directory_schedule( self ):
return self.get_bool_value( 'snapshots.expert.per_directory_schedule', False )
def set_per_directory_schedule( self, value ):
return self.set_bool_value( 'snapshots.expert.per_directory_schedule', value )
def get_remove_old_snapshots( self ):
return ( self.get_bool_value( 'snapshots.remove_old_snapshots.enabled', True ),
self.get_int_value( 'snapshots.remove_old_snapshots.value', 10 ),
self.get_int_value( 'snapshots.remove_old_snapshots.unit', self.YEAR ) )
def is_remove_old_snapshots_enabled( self ):
return self.get_bool_value( 'snapshots.remove_old_snapshots.enabled', True )
def get_remove_old_snapshots_date( self ):
enabled, value, unit = self.get_remove_old_snapshots()
if not enabled:
return datetime.date( 1, 1, 1 )
if unit == self.DAY:
date = datetime.date.today()
date = date - datetime.timedelta( days = value )
return date
if unit == self.WEEK:
date = datetime.date.today()
date = date - datetime.timedelta( days = date.weekday() + 7 * value )
return date
if unit == self.YEAR:
date = datetime.date.today()
return date.replace( year = date.year - value )
return datetime.date( 1, 1, 1 )
def set_remove_old_snapshots( self, enabled, value, unit ):
self.set_bool_value( 'snapshots.remove_old_snapshots.enabled', enabled )
self.set_int_value( 'snapshots.remove_old_snapshots.value', value )
self.set_int_value( 'snapshots.remove_old_snapshots.unit', unit )
def get_min_free_space( self ):
return ( self.get_bool_value( 'snapshots.min_free_space.enabled', True ),
self.get_int_value( 'snapshots.min_free_space.value', 1 ),
self.get_int_value( 'snapshots.min_free_space.unit', self.DISK_UNIT_GB ) )
def is_min_free_space_enabled( self ):
return self.get_bool_value( 'snapshots.min_free_space.enabled', True )
def get_min_free_space_in_mb( self ):
enabled, value, unit = self.get_min_free_space()
if not enabled:
return 0
if self.DISK_UNIT_MB == unit:
return value
value *= 1024 #Gb
if self.DISK_UNIT_GB == unit:
return value
return 0
def set_min_free_space( self, enabled, value, unit ):
self.set_bool_value( 'snapshots.min_free_space.enabled', enabled )
self.set_int_value( 'snapshots.min_free_space.value', value )
self.set_int_value( 'snapshots.min_free_space.unit', unit )
def get_dont_remove_named_snapshots( self ):
return self.get_bool_value( 'snapshots.dont_remove_named_snapshots', True )
def set_dont_remove_named_snapshots( self, value ):
self.set_bool_value( 'snapshots.dont_remove_named_snapshots', value )
def get_smart_remove( self ):
return self.get_bool_value( 'snapshots.smart_remove', False )
def set_smart_remove( self, value ):
self.set_bool_value( 'snapshots.smart_remove', value )
def is_notify_enabled( self ):
return self.get_bool_value( 'snapshots.notify.enabled', True )
def set_notify_enabled( self, value ):
self.set_bool_value( 'snapshots.notify.enabled', value )
def is_run_nice_from_cron_enabled( self ):
return self.get_bool_value( 'snapshots.cron.nice', True )
def set_run_nice_from_cron_enabled( self, value ):
self.set_bool_value( 'snapshots.cron.nice', value )
def get_take_snapshot_user_script( self, step ):
return self.get_str_value( "snapshots.take_snapshot.%s.user.script" )
def set_take_snapshot_user_script( self, step, path ):
self.set_str_value( "snapshots.take_snapshot.%s.user.script" % step, path )
def get_take_snapshot_user_script_before( self ):
return self.get_take_snapshot_user_script( 'before' )
def set_take_snapshot_user_script_before( self, path ):
self.set_take_snapshot_user_script( 'before', path )
def get_take_snapshot_user_script_after( self ):
return self.get_take_snapshot_user_script( 'after' )
def set_take_snapshot_user_script_after( self, path ):
self.set_take_snapshot_user_script( 'after', path )
def get_take_snapshot_user_script_new_snapshot( self ):
return self.get_take_snapshot_user_script( 'new_snapshot' )
def set_take_snapshot_user_script_new_snapshot( self, path ):
self.set_take_snapshot_user_script( 'new_snapshot', path )
def get_take_snapshot_user_script_error( self ):
return self.get_take_snapshot_user_script( 'error' )
def set_take_snapshot_user_script_error( self, path ):
self.set_take_snapshot_user_script( 'error', path )
def get_app_path( self ):
return self._APP_PATH
def get_doc_path( self ):
return self._DOC_PATH
def get_app_instance_file( self ):
return os.path.join( self._LOCAL_DATA_FOLDER, 'app.lock' )
def get_take_snapshot_message_file( self ):
return os.path.join( self._LOCAL_DATA_FOLDER, 'worker.message' )
def get_take_snapshot_instance_file( self ):
return os.path.join( self._LOCAL_DATA_FOLDER, 'worker.lock' )
def get_last_snapshot_info_file( self ):
return os.path.join( self._LOCAL_DATA_FOLDER, 'snapshot.last' )
def get_take_snapshot_user_callback( self ):
return os.path.join( self._LOCAL_CONFIG_FOLDER, 'user.callback' )
def get_license( self ):
return tools.read_file( os.path.join( self.get_doc_path(), 'LICENSE' ), '' )
def get_translations( self ):
return tools.read_file( os.path.join( self.get_doc_path(), 'TRANSLATIONS' ), '' )
def get_authors( self ):
return tools.read_file( os.path.join( self.get_doc_path(), 'AUTHORS' ), '' )
def prepare_path( self, path ):
if len( path ) > 1:
if path[ -1 ] == os.sep:
path = path[ : -1 ]
return path
def is_configured( self ):
if len( self.get_snapshots_path() ) == 0:
return False
if len( self.get_include_folders() ) == 0:
return False
return True
def can_backup( self ):
if not self.is_configured():
return False
if not os.path.isdir( self.get_snapshots_full_path() ):
return False
return True
def setup_cron( self ):
#auto_backup_mode = self.get_automatic_backup_mode()
min_backup_mode = self.NONE
max_backup_mode = self.NONE
if self.get_per_directory_schedule():
for item in self.get_include_folders():
backup_mode = item[1]
if self.NONE != backup_mode:
if self.NONE == min_backup_mode:
min_backup_mode = backup_mode
max_backup_mode = backup_mode
elif backup_mode < min_backup_mode:
min_backup_mode = backup_mode
elif backup_mode > max_backup_mode:
max_backup_mode = backup_mode
print "Min automatic backup: %s" % self.AUTOMATIC_BACKUP_MODES[ min_backup_mode ]
print "Max automatic backup: %s" % self.AUTOMATIC_BACKUP_MODES[ max_backup_mode ]
else:
min_backup_mode = self.get_automatic_backup_mode()
max_backup_mode = min_backup_mode
print "Automatic backup: %s" % self.AUTOMATIC_BACKUP_MODES[ min_backup_mode ]
if self.NONE == min_backup_mode:
os.system( "crontab -l | grep -v backintime | crontab -" )
return None #no automatic backup
if not tools.check_command( 'crontab' ):
return _( 'Can\'t find crontab.\nAre you sure cron is installed ?\nIf not you should disable all automatic backups.' )
#remove old cron
os.system( "crontab -l | grep -v backintime | crontab -" )
cron_line = ''
if self._5_MIN == min_backup_mode:
cron_line = 'echo "*/5 * * * * {cmd}"'
elif self._10_MIN == min_backup_mode:
cron_line = 'echo "*/10 * * * * {cmd}"'
if self.HOUR == min_backup_mode:
cron_line = 'echo "@hourly {cmd}"'
elif self.DAY == min_backup_mode:
cron_line = 'echo "@daily {cmd}"'
elif self.WEEK == min_backup_mode and self.MONTH == max_backup_mode: #for every-week and every-month use every-day
cron_line = 'echo "@daily {cmd}"'
elif self.WEEK == min_backup_mode:
cron_line = 'echo "@weekly {cmd}"'
elif self.MONTH == min_backup_mode:
cron_line = 'echo "@monthly {cmd}"'
if len( cron_line ) > 0:
cmd = '/usr/bin/backintime --backup-job >/dev/null 2>&1'
if self.is_run_nice_from_cron_enabled():
cmd = 'nice -n 19 ' + cmd
cron_line = cron_line.replace( '{cmd}', cmd )
os.system( "( crontab -l; %s ) | crontab -" % cron_line )
return None
if __name__ == "__main__":
config = Config()
print "snapshots path = %s" % config.get_snapshots_full_path()
|