/usr/share/backintime/common/config.py is in backintime-common 1.0.34-0.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 | # Back In Time
# Copyright (C) 2008-2009 Oprea Dan, Bart de Koning, Richard Bailey
#
# 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 socket
import random
import re
import tempfile
import stat
import configfile
import tools
import logger
import mount
import sshtools
import encfstools
##import dummytools
import password
_=gettext.gettext
gettext.bindtextdomain( 'backintime', '/usr/share/locale' )
gettext.textdomain( 'backintime' )
class Config( configfile.ConfigFileWithProfiles ):
APP_NAME = 'Back In Time'
VERSION = '1.0.34'
COPYRIGHT = 'Copyright (c) 2008-2013 Oprea Dan, Bart de Koning, Richard Bailey, Germar Reitze'
CONFIG_VERSION = 5
NONE = 0
AT_EVERY_BOOT = 1
_5_MIN = 2
_10_MIN = 4
_30_MIN = 7
_1_HOUR = 10
_2_HOURS = 12
_4_HOURS = 14
_6_HOURS = 16
_12_HOURS = 18
CUSTOM_HOUR = 19
DAY = 20
DAY_ANACRON = 25
UDEV = 27
WEEK = 30
MONTH = 40
YEAR = 80
DISK_UNIT_MB = 10
DISK_UNIT_GB = 20
AUTOMATIC_BACKUP_MODES = {
NONE : _('Disabled'),
AT_EVERY_BOOT : _('At every boot/reboot'),
_5_MIN: _('Every 5 minutes'),
_10_MIN: _('Every 10 minutes'),
_30_MIN: _('Every 30 minutes'),
_1_HOUR : _('Every hour'),
_2_HOURS : _('Every 2 hours'),
_4_HOURS : _('Every 4 hours'),
_6_HOURS : _('Every 6 hours'),
_12_HOURS : _('Every 12 hours'),
CUSTOM_HOUR : _('Custom Hours'),
DAY : _('Every Day'),
DAY_ANACRON : _('Daily (anacron)'),
UDEV : _('When drive get connected (udev)'),
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' }
DEFAULT_EXCLUDE = [ '.gvfs', '.cache*', '[Cc]ache*', '.thumbnails*', '[Tt]rash*', '*.backup*', '*~', os.path.expanduser( '~/Ubuntu One' ), '.dropbox*', '/proc/*', '/sys/*', '/dev/*', '/run/*' ]
exp = _(' EXPERIMENTAL!')
SNAPSHOT_MODES = {
#mode : (<mounttools>, 'ComboBox Text', need_pw|lbl_pw_1, need_2_pw|lbl_pw_2 ),
'local' : (None, _('Local'), False, False ),
'ssh' : (sshtools.SSH, _('SSH'), _('SSH private key'), False ),
'local_encfs' : (encfstools.EncFS_mount, _('Local encrypted'), _('Encryption'), False ),
'ssh_encfs' : (encfstools.EncFS_SSH, _('SSH encrypted'), _('SSH private key'), _('Encryption') )
##'dummy' : (dummytools.Dummy, 'Dummy', 'Dummy', False )
}
MOUNT_ROOT = '/tmp/backintime'
SSH_CIPHERS = {'default': _('Default'),
'aes128-ctr': _('AES128-CTR'),
'aes192-ctr': _('AES192-CTR'),
'aes256-ctr': _('AES256-CTR'),
'arcfour256': _('ARCFOUR256'),
'arcfour128': _('ARCFOUR128'),
'aes128-cbc': _('AES128-CBC'),
'3des-cbc': _('3DES-CBC'),
'blowfish-cbc': _('Blowfish-CBC'),
'cast128-cbc': _('Cast128-CBC'),
'aes192-cbc': _('AES192-CBC'),
'aes256-cbc': _('AES256-CBC'),
'arcfour': _('ARCFOUR') }
ENCODE = encfstools.Bounce()
def __init__( self, config_path = None ):
configfile.ConfigFileWithProfiles.__init__( self, _('Main profile') )
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._DEFAULT_CONFIG_PATH = os.path.join( self._LOCAL_CONFIG_FOLDER, 'config' )
if config_path is None:
self._LOCAL_CONFIG_PATH = self._DEFAULT_CONFIG_PATH
else:
self._LOCAL_CONFIG_PATH = config_path
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', self.CONFIG_VERSION ) < self.CONFIG_VERSION:
if self.get_int_value( 'config.version', self.CONFIG_VERSION ) < 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', self.CONFIG_VERSION ) < 3:
self.remap_key( 'snapshots.path', 'profile1.snapshots.path' )
self.remap_key( 'snapshots.include_folders', 'profile1.snapshots.include_folders' )
self.remap_key( 'snapshots.exclude_patterns', 'profile1.snapshots.exclude_patterns' )
self.remap_key( 'snapshots.automatic_backup_mode', 'profile1.snapshots.automatic_backup_mode' )
self.remap_key( 'snapshots.remove_old_snapshots.enabled', 'profile1.snapshots.remove_old_snapshots.enabled' )
self.remap_key( 'snapshots.remove_old_snapshots.value', 'profile1.snapshots.remove_old_snapshots.value' )
self.remap_key( 'snapshots.remove_old_snapshots.unit', 'profile1.snapshots.remove_old_snapshots.unit' )
self.remap_key( 'snapshots.min_free_space.enabled', 'profile1.snapshots.min_free_space.enabled' )
self.remap_key( 'snapshots.min_free_space.value', 'profile1.snapshots.min_free_space.value' )
self.remap_key( 'snapshots.min_free_space.unit', 'profile1.snapshots.min_free_space.unit' )
self.remap_key( 'snapshots.dont_remove_named_snapshots', 'profile1.snapshots.dont_remove_named_snapshots' )
if self.get_int_value( 'config.version', self.CONFIG_VERSION ) < 4:
# version 4 uses as path backintime/machine/user/profile_id
# but must be able to read old paths
profiles = self.get_profiles()
self.set_bool_value( 'update.other_folders', True )
logger.info( "Update to config version 4: other snapshot locations" )
for profile_id in profiles:
old_folder = self.get_snapshots_path( profile_id )
other_folder = os.path.join( old_folder, 'backintime' )
other_folder_key = 'profile' + str( profile_id ) + '.snapshots.other_folders'
self.set_str_value( other_folder_key, other_folder )
#self.set_snapshots_path( old_folder, profile_id )
tag = str( random.randint(100, 999) )
logger.info( "Random tag for profile %s: %s" %( profile_id, tag ) )
self.set_profile_str_value( 'snapshots.tag', tag, profile_id )
if self.get_int_value( 'config.version', self.CONFIG_VERSION ) < 5:
logger.info( "Update to config version 5: other snapshot locations" )
profiles = self.get_profiles()
for profile_id in profiles:
#change include
old_values = self.get_include_v4( profile_id )
values = []
for value in old_values:
values.append( ( value, 0 ) )
self.set_include( values, profile_id )
#change exclude
old_values = self.get_exclude_v4( profile_id )
self.set_exclude( old_values, profile_id )
#remove keys
self.remove_profile_key( 'snapshots.include_folders', profile_id )
self.remove_profile_key( 'snapshots.exclude_patterns', profile_id )
self.set_int_value( 'config.version', self.CONFIG_VERSION )
self.save()
self.current_hash_id = 'local'
self.pw = None
self.force_use_checksum = False
def save( self ):
configfile.ConfigFile.save( self, self._LOCAL_CONFIG_PATH )
def check_config( self ):
profiles = self.get_profiles()
checked_profiles = []
for profile_id in profiles:
profile_name = self.get_profile_name( profile_id )
snapshots_path = self.get_snapshots_path( profile_id )
#check snapshots path
if len( snapshots_path ) <= 0:
self.notify_error( _('Profile: "%s"') % profile_name + '\n' + _('Snapshots folder is not valid !') )
return False
## Should not check for similar snapshot paths any longer!
#for other_profile in checked_profiles:
# if snapshots_path == self.get_snapshots_path( other_profile[0] ):
# self.notify_error( _('Profiles "%s" and "%s" have the same snapshots path !') % ( profile_name, other_profile[1] ) )
# return False
#
#if not os.path.isdir( snapshots_path ):
# return ( 0, _('Snapshots folder is not valid !') )
#if len( self.get_snapshots_path( profile_id ) ) <= 1:
# return ( 0, _('Snapshots folder can\'t be the root folder !') )
#check include
include_list = self.get_include( profile_id )
if len( include_list ) <= 0:
self.notify_error( _('Profile: "%s"') % profile_name + '\n' + _('You must select at least one folder to backup !') )
return False
snapshots_path2 = snapshots_path + '/'
for item in include_list:
if item[1] != 0:
continue
path = item[0]
if path == snapshots_path:
self.notify_error( _('Profile: "%s"') % profile_name + '\n' + _('You can\'t include backup folder !') )
return False
if len( path ) >= len( snapshots_path2 ):
if path[ : len( snapshots_path2 ) ] == snapshots_path2:
self.notify_error( _('Profile: "%s"') % self.get_current_profile(), + '\n' + _('You can\'t include a backup sub-folder !') )
return False
checked_profiles.append( ( profile_id, profile_name ) )
return True
def get_user( self ):
user = ''
try:
user = os.environ['USER']
except:
user = ''
if len( user ) != 0:
return user
try:
user = os.environ['LOGNAME']
except:
user = ''
return user
def get_pid(self):
return str(os.getpid())
def get_host(self):
return socket.gethostname()
def get_snapshots_path( self, profile_id = None, mode = None, tmp_mount = False ):
if mode is None:
mode = self.get_snapshots_mode(profile_id)
if self.SNAPSHOT_MODES[mode][0] == None:
#no mount needed
#?Where to save snapshots in mode 'local'. This path must contain a
#?folderstructure like 'backintime/<HOST>/<USER>/<PROFILE_ID>';absolute path
return self.get_profile_str_value( 'snapshots.path', '', profile_id )
else:
#mode need to be mounted; return mountpoint
symlink = self.get_snapshots_symlink(profile_id = profile_id, tmp_mount = tmp_mount)
return os.path.join(self.MOUNT_ROOT, self.get_user(), symlink)
def get_snapshots_full_path( self, profile_id = None, version = None ):
'''Returns the full path for the snapshots: .../backintime/machine/user/profile_id/'''
if version is None:
version = self.get_int_value( 'config.version', self.CONFIG_VERSION )
if version < 4:
return os.path.join( self.get_snapshots_path( profile_id ), 'backintime' )
else:
host, user, profile = self.get_host_user_profile( profile_id )
return os.path.join( self.get_snapshots_path( profile_id ), 'backintime', host, user, profile )
def set_snapshots_path( self, value, profile_id = None, mode = None ):
"""Sets the snapshot path to value, initializes, and checks it"""
if len( value ) <= 0:
return False
if profile_id == None:
# print("BUG: calling set_snapshots_path without profile_id!")
# tjoep
# return False
profile_id = self.get_current_profile()
if mode is None:
mode = self.get_snapshots_mode( profile_id )
if not os.path.isdir( value ):
self.notify_error( _( '%s is not a folder !' ) % value )
return False
#Initialize the snapshots folder
print("Check snapshot folder: %s" % value)
#machine = socket.gethostname()
#user = self.get_user()
host, user, profile = self.get_host_user_profile( profile_id )
full_path = os.path.join( value, 'backintime', host, user, profile )
if not os.path.isdir( full_path ):
print("Create folder: %s" % full_path)
tools.make_dirs( full_path )
if not os.path.isdir( full_path ):
self.notify_error( _( 'Can\'t write to: %s\nAre you sure you have write access ?' % value ) )
return False
path1 = os.path.join( value, 'backintime' )
os.system( "chmod a+rwx \"%s\"" % path1 )
path1 = os.path.join( value, 'backintime', host )
os.system( "chmod a+rwx \"%s\"" % path1 )
#Test write access for the folder
check_path = os.path.join( full_path, 'check' )
tools.make_dirs( check_path )
if not os.path.isdir( check_path ):
self.notify_error( _( 'Can\'t write to: %s\nAre you sure you have write access ?' % full_path ) )
return False
os.rmdir( check_path )
if self.SNAPSHOT_MODES[mode][0] is None:
self.set_profile_str_value( 'snapshots.path', value, profile_id )
return True
def get_snapshots_mode( self, profile_id = None ):
#?Use mode (or backend) for this snapshot. Look at 'man backintime'
#?section 'Modes'.;local|local_encfs|ssh|ssh_encfs
return self.get_profile_str_value( 'snapshots.mode', 'local', profile_id )
def set_snapshots_mode( self, value, profile_id = None ):
self.set_profile_str_value( 'snapshots.mode', value, profile_id )
def get_snapshots_symlink(self, profile_id = None, tmp_mount = False):
if profile_id is None:
profile_id = self.current_profile_id
symlink = '%s_%s' % (profile_id, self.get_pid())
if tmp_mount:
symlink = 'tmp_%s' % symlink
return symlink
def set_current_hash_id(self, hash_id):
self.current_hash_id = hash_id
def get_hash_collision(self):
#?Internal value used to prevent hash collisions on mountpoints. Do not change this.
return self.get_int_value( 'global.hash_collision', 0 )
def increment_hash_collision(self):
value = self.get_hash_collision() + 1
self.set_int_value( 'global.hash_collision', value )
def get_snapshots_path_ssh( self, profile_id = None ):
#?Snapshot path on remote host. If the path is relative (no leading '/')
#?it will start from remote Users homedir. An empty path will be replaced
#?with './'. This path must contain a folderstructure like
#?'backintime/<HOST>/<USER>/<PROFILE_ID>';absolute or relative path
return self.get_profile_str_value( 'snapshots.ssh.path', '', profile_id )
def get_snapshots_full_path_ssh( self, profile_id = None, version = None ):
'''Returns the full path for the snapshots: .../backintime/machine/user/profile_id/'''
if version is None:
version = self.get_int_value( 'config.version', self.CONFIG_VERSION )
path = self.get_snapshots_path_ssh( profile_id )
if len(path) == 0:
path = './'
if version < 4:
return os.path.join( path, 'backintime' )
else:
host, user, profile = self.get_host_user_profile( profile_id )
return os.path.join( path, 'backintime', host, user, profile )
def set_snapshots_path_ssh( self, value, profile_id = None ):
self.set_profile_str_value( 'snapshots.ssh.path', value, profile_id )
return True
def get_ssh_host( self, profile_id = None ):
#?Remote host used for mode 'ssh' and 'ssh_encfs'.;IP or domain address
return self.get_profile_str_value( 'snapshots.ssh.host', '', profile_id )
def set_ssh_host( self, value, profile_id = None ):
self.set_profile_str_value( 'snapshots.ssh.host', value, profile_id )
def get_ssh_port( self, profile_id = None ):
#?SSH Port on remote host.;0-65535
return self.get_profile_int_value( 'snapshots.ssh.port', '22', profile_id )
def set_ssh_port( self, value, profile_id = None ):
self.set_profile_int_value( 'snapshots.ssh.port', value, profile_id )
def get_ssh_cipher( self, profile_id = None ):
#?Cipher that is used for encrypting the SSH tunnel. Depending on the
#?environment (network bandwidth, cpu and hdd performance) a different
#?cipher might be faster.;default|aes192-cbc|aes256-cbc|aes128-ctr|
#?aes192-ctr|aes256-ctr|arcfour|arcfour256|arcfour128|aes128-cbc|
#?3des-cbc|blowfish-cbc|cast128-cbc
return self.get_profile_str_value( 'snapshots.ssh.cipher', 'default', profile_id )
def set_ssh_cipher( self, value, profile_id = None ):
self.set_profile_str_value( 'snapshots.ssh.cipher', value, profile_id )
def get_ssh_user( self, profile_id = None ):
#?Remote SSH user;;local users name
return self.get_profile_str_value( 'snapshots.ssh.user', self.get_user(), profile_id )
def set_ssh_user( self, value, profile_id = None ):
self.set_profile_str_value( 'snapshots.ssh.user', value, profile_id )
def get_ssh_host_port_user_path_cipher(self, profile_id = None ):
host = self.get_ssh_host(profile_id)
port = self.get_ssh_port(profile_id)
user = self.get_ssh_user(profile_id)
path = self.get_snapshots_path_ssh(profile_id)
cipher = self.get_ssh_cipher(profile_id)
if len(path) == 0:
path = './'
return (host, port, user, path, cipher)
def get_ssh_private_key_file(self, profile_id = None):
ssh = self.get_ssh_private_key_folder()
default = ''
for file in ['id_dsa', 'id_rsa', 'identity']:
private_key = os.path.join(ssh, file)
if os.path.isfile(private_key):
default = private_key
break
#?Private key file used for password-less authentication on remote host.
#?;absolute path to private key file;~/.ssh/id_dsa
file = self.get_profile_str_value( 'snapshots.ssh.private_key_file', default, profile_id )
if len(file) == 0:
return default
else:
return file
def get_ssh_private_key_folder(self):
return os.path.join(os.path.expanduser('~'), '.ssh')
def set_ssh_private_key_file( self, value, profile_id = None ):
self.set_profile_str_value( 'snapshots.ssh.private_key_file', value, profile_id )
#ENCFS
def get_local_encfs_path( self, profile_id = None ):
#?Where to save snapshots in mode 'local_encfs'. The encrypted path must contian
#?a folderstructure like 'backintime/<HOST>/<USER>/<PROFILE_ID>';absolute path
return self.get_profile_str_value( 'snapshots.local_encfs.path', '', profile_id )
def set_local_encfs_path( self, value, profile_id = None ):
self.set_profile_str_value( 'snapshots.local_encfs.path', value, profile_id )
## def get_dummy_host( self, profile_id = None ):
## return self.get_profile_str_value( 'snapshots.dummy.host', '', profile_id )
##
## def set_dummy_host( self, value, profile_id = None ):
## self.set_profile_str_value( 'snapshots.dummy.host', value, profile_id )
##
## def get_dummy_port( self, profile_id = None ):
## return self.get_profile_int_value( 'snapshots.dummy.port', '22', profile_id )
##
## def set_dummy_port( self, value, profile_id = None ):
## self.set_profile_int_value( 'snapshots.dummy.port', value, profile_id )
##
## def get_dummy_user( self, profile_id = None ):
## return self.get_profile_str_value( 'snapshots.dummy.user', self.get_user(), profile_id )
##
## def set_dummy_user( self, value, profile_id = None ):
## self.set_profile_str_value( 'snapshots.dummy.user', value, profile_id )
def get_password_save( self, profile_id = None, mode = None ):
if mode is None:
mode = self.get_snapshots_mode(profile_id)
#?Save password to system keyring (gnome-keyring or kwallet).
#?<MODE> must be the same as \fIprofile<N>.snapshots.mode\fR
return self.get_profile_bool_value( 'snapshots.%s.password.save' % mode, False, profile_id )
def set_password_save( self, value, profile_id = None, mode = None ):
if mode is None:
mode = self.get_snapshots_mode(profile_id)
self.set_profile_bool_value( 'snapshots.%s.password.save' % mode, value, profile_id )
def get_password_use_cache( self, profile_id = None, mode = None ):
if mode is None:
mode = self.get_snapshots_mode(profile_id)
default = not tools.check_home_encrypt()
#?Cache password in RAM so it can be read by cronjobs.
#?Security issue: root might be able to read that password, too.
#?<MODE> must be the same as \fIprofile<N>.snapshots.mode\fR;;true if home is not encrypted
return self.get_profile_bool_value( 'snapshots.%s.password.use_cache' % mode, default, profile_id )
def set_password_use_cache( self, value, profile_id = None, mode = None ):
if mode is None:
mode = self.get_snapshots_mode(profile_id)
self.set_profile_bool_value( 'snapshots.%s.password.use_cache' % mode, value, profile_id )
def get_password( self, parent = None, profile_id = None, mode = None, pw_id = 1, only_from_keyring = False ):
if self.pw is None:
self.pw = password.Password(self)
if profile_id is None:
profile_id = self.get_current_profile()
if mode is None:
mode = self.get_snapshots_mode(profile_id)
return self.pw.get_password(parent, profile_id, mode, pw_id, only_from_keyring)
def set_password( self, password, profile_id = None, mode = None, pw_id = 1 ):
if self.pw is None:
self.pw = password.Password(self)
if profile_id is None:
profile_id = self.get_current_profile()
if mode is None:
mode = self.get_snapshots_mode(profile_id)
self.pw.set_password(password, profile_id, mode, pw_id)
def mode_need_password(self, mode, pw_id = 1):
need_pw = self.SNAPSHOT_MODES[mode][pw_id + 1]
if need_pw is False:
return False
return True
def get_keyring_service_name( self, profile_id = None, mode = None, pw_id = 1 ):
if mode is None:
mode = self.get_snapshots_mode(profile_id)
if pw_id > 1:
return 'backintime/%s_%s' % (mode, pw_id)
return 'backintime/%s' % mode
def get_keyring_user_name( self, profile_id = None ):
if profile_id is None:
profile_id = self.get_current_profile()
return 'profile_id_%s' % profile_id
def get_auto_host_user_profile( self, profile_id = None ):
#?Automaticaly set HOST, USER and PROFILE_ID for snapshot path.
return self.get_profile_bool_value( 'snapshots.path.auto', True, profile_id )
def set_auto_host_user_profile( self, value, profile_id = None ):
self.set_profile_bool_value( 'snapshots.path.auto', value, profile_id )
def get_default_host_user_profile( self, profile_id = None ):
host = socket.gethostname()
user = self.get_user()
profile = profile_id
if profile is None:
profile = self.get_current_profile()
return ( host, user, profile )
def get_host_user_profile( self, profile_id = None ):
default_host, default_user, default_profile = self.get_default_host_user_profile( profile_id )
if self.get_auto_host_user_profile( profile_id ):
return ( default_host, default_user, default_profile )
#?Set Host for snapshot path if \fIprofile<N>.snapshots.path.auto\fR
#?is false;;local hostname
host = self.get_profile_str_value( 'snapshots.path.host', default_host, profile_id )
if len( host ) <= 0:
host = default_host
#?Set User for snapshot path if \fIprofile<N>.snapshots.path.auto\fR
#?is false;;local username
user = self.get_profile_str_value( 'snapshots.path.user', default_user, profile_id )
if len( user ) <= 0:
user = default_user
#?Set Profile-ID for snapshot path if \fIprofile<N>.snapshots.path.auto\fR
#?is false;1-99999;current Profile-ID
profile = self.get_profile_str_value( 'snapshots.path.profile', default_profile, profile_id )
if len( profile ) <= 0:
profile = default_profile
return ( host, user, profile )
def set_host_user_profile( self, host, user, profile, profile_id = None ):
if profile_id is None:
profile_id = self.get_current_profile()
self.set_profile_str_value( 'snapshots.path.host', host, profile_id )
self.set_profile_str_value( 'snapshots.path.user', user, profile_id )
self.set_profile_str_value( 'snapshots.path.profile', profile, profile_id )
def get_other_folders_paths( self, profile_id = None ):
'''Returns the other snapshots folders paths as a list'''
#?!ignore this in manpage
value = self.get_profile_str_value( 'snapshots.other_folders', '', profile_id )
if len( value ) <= 0:
return []
paths = []
for item in value.split(':'):
fields = item.split( '|' )
path = os.path.expanduser( item )
path = os.path.abspath( path )
paths.append( ( path ) )
return paths
def get_include_v4( self, profile_id = None ):
#?!ignore this in manpage
value = self.get_profile_str_value( 'snapshots.include_folders', '', profile_id )
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 ) )
paths.append( path )
return paths
def get_include( self, profile_id = None ):
#?Quantity of include entrys.;1-99999
size = self.get_profile_int_value( 'snapshots.include.size', -1, profile_id )
if size <= 0:
return []
include = []
for i in xrange( 1, size + 1 ):
#?Include this file or folder. <I> must be a counter
#?starting with 1;absolute path
value = self.get_profile_str_value( "snapshots.include.%s.value" % i, '', profile_id )
if len( value ) > 0:
#?Specify if \fIprofile<N>.snapshots.include.<I>.value\fR
#?is a folder (0) or a file (1).;0|1
type = self.get_profile_int_value( "snapshots.include.%s.type" % i, 0, profile_id )
include.append( ( value, type ) )
return include
def set_include( self, _list, profile_id = None ):
old_size = self.get_profile_int_value( 'snapshots.include.size', 0, profile_id )
counter = 0
for value in _list:
if len( value[0] ) > 0:
counter = counter + 1
self.set_profile_str_value( "snapshots.include.%s.value" % counter, value[0], profile_id )
self.set_profile_int_value( "snapshots.include.%s.type" % counter, value[1], profile_id )
self.set_profile_int_value( 'snapshots.include.size', counter, profile_id )
if counter < old_size:
for i in xrange( counter + 1, old_size + 1 ):
self.remove_profile_key( "snapshots.include.%s.value" % i, profile_id )
self.remove_profile_key( "snapshots.include.%s.type" % i, profile_id )
def get_exclude_v4( self, profile_id = None ):
'''Gets the exclude patterns: conf version 4'''
#?!ignore this in manpage
value = self.get_profile_str_value( 'snapshots.exclude_patterns', '.gvfs:.cache*:[Cc]ache*:.thumbnails*:[Tt]rash*:*.backup*:*~', profile_id )
if len( value ) <= 0:
return []
return value.split( ':' )
def get_exclude( self, profile_id = None ):
'''Gets the exclude patterns'''
#?Quantity of exclude entrys.;1-99999
size = self.get_profile_int_value( 'snapshots.exclude.size', -1, profile_id )
if size < 0:
return self.DEFAULT_EXCLUDE
exclude = []
for i in xrange( 1, size + 1 ):
#?Exclude this file or folder. <I> must be a counter
#?starting with 1;file, folder or pattern (relative or absolute)
value = self.get_profile_str_value( "snapshots.exclude.%s.value" % i, '', profile_id )
if len( value ) > 0:
exclude.append( value )
return exclude
def set_exclude( self, _list, profile_id = None ):
old_size = self.get_profile_int_value( 'snapshots.exclude.size', 0, profile_id )
counter = 0
for value in _list:
if len( value ) > 0:
counter = counter + 1
self.set_profile_str_value( "snapshots.exclude.%s.value" % counter, value, profile_id )
self.set_profile_int_value( 'snapshots.exclude.size', counter, profile_id )
if counter < old_size:
for i in xrange( counter + 1, old_size + 1 ):
self.remove_profile_key( "snapshots.exclude.%s.value" % i, profile_id )
def get_tag( self, profile_id = None ):
#?!ignore this in manpage
return self.get_profile_str_value( 'snapshots.tag', str(random.randint(100, 999)), profile_id )
def get_automatic_backup_mode( self, profile_id = None ):
#?Which shedule used for crontab. Note that the crontab entry is only
#?generated during saving in settings dialog. If you don't run a GUI
#?version of BackInTime you'll have to create the crontab entry on your
#?own.\n 0 = Disabled\n 1 = at every boot\n 2 = every 5 minute\n
#? 4 = every 10 minute\n 7 = every 30 minute\n10 = every hour\n
#?12 = every 2 hours\n14 = every 4 hours\n16 = every 6 hours\n
#?18 = every 12 hours\n19 = custom defined hours\n20 = every day\n
#?25 = daily anacron\n27 = when drive get connected\n30 = every week\n
#?40 = every month\n80 = every year
#?;0|1|2|4|7|10|12|14|16|18|19|20|25|27|30|40|80;0
return self.get_profile_int_value( 'snapshots.automatic_backup_mode', self.NONE, profile_id )
def set_automatic_backup_mode( self, value, profile_id = None ):
self.set_profile_int_value( 'snapshots.automatic_backup_mode', value, profile_id )
def get_automatic_backup_time( self, profile_id = None ):
#?What time the cronjob should run? Only valid for
#?\fIprofile<N>.snapshots.automatic_backup_mode\fR >= 20;0-24
return self.get_profile_int_value( 'snapshots.automatic_backup_time', 0, profile_id )
def set_automatic_backup_time( self, value, profile_id = None ):
self.set_profile_int_value( 'snapshots.automatic_backup_time', value, profile_id )
def get_automatic_backup_day( self, profile_id = None ):
#?Which day of month the cronjob should run? Only valid for
#?\fIprofile<N>.snapshots.automatic_backup_mode\fR >= 40;1-28
return self.get_profile_int_value( 'snapshots.automatic_backup_day', 1, profile_id )
def set_automatic_backup_day( self, value, profile_id = None ):
self.set_profile_int_value( 'snapshots.automatic_backup_day', value, profile_id )
def get_automatic_backup_weekday( self, profile_id = None ):
#?Which day of week the cronjob should run? Only valid for
#?\fIprofile<N>.snapshots.automatic_backup_mode\fR = 30;1 = monday - 7 = sunday
return self.get_profile_int_value( 'snapshots.automatic_backup_weekday', 7, profile_id )
def set_automatic_backup_weekday( self, value, profile_id = None ):
self.set_profile_int_value( 'snapshots.automatic_backup_weekday', value, profile_id )
def get_custom_backup_time( self, profile_id = None ):
#?Custom hours for cronjob. Only valid for
#?\fIprofile<N>.snapshots.automatic_backup_mode\fR = 19
#?;comma separated int (8,12,18,23) or */3;8,12,18,23
return self.get_profile_str_value( 'snapshots.custom_backup_time', '8,12,18,23', profile_id )
def set_custom_backup_time( self, value, profile_id = None ):
self.set_profile_str_value( 'snapshots.custom_backup_time', value, profile_id )
def get_automatic_backup_anacron_period(self, profile_id = None):
#?How many days to wait between new snapshots with anacron? Only valid
#?for \fIprofile<N>.snapshots.automatic_backup_mode\fR = 25|27
return self.get_profile_int_value('snapshots.automatic_backup_anacron_period', 1, profile_id)
def set_automatic_backup_anacron_period(self, value, profile_id = None):
self.set_profile_int_value('snapshots.automatic_backup_anacron_period', value, profile_id)
#def get_per_directory_schedule( self, profile_id = None ):
# return self.get_profile_bool_value( 'snapshots.expert.per_directory_schedule', False, profile_id )
#def set_per_directory_schedule( self, value, profile_id = None ):
# return self.set_profile_bool_value( 'snapshots.expert.per_directory_schedule', value, profile_id )
def get_remove_old_snapshots( self, profile_id = None ):
#?Remove all snapshots older than value + unit
return ( self.get_profile_bool_value( 'snapshots.remove_old_snapshots.enabled', True, profile_id ),
#?Snapshots older than this times units will be removed
self.get_profile_int_value( 'snapshots.remove_old_snapshots.value', 10, profile_id ),
#?20 = days\n30 = weeks\n80 = years;20|30|80;80
self.get_profile_int_value( 'snapshots.remove_old_snapshots.unit', self.YEAR, profile_id ) )
def keep_only_one_snapshot( self, profile_id = None ):
#?NOT YET IMPLEMENTED. Remove all snapshots but one.
return self.get_profile_bool_value( 'snapshots.keep_only_one_snapshot.enabled', False, profile_id )
def set_keep_only_one_snapshot( self, value, profile_id = None ):
self.set_profile_bool_value( 'snapshots.keep_only_one_snapshot.enabled', value, profile_id )
def is_remove_old_snapshots_enabled( self, profile_id = None ):
return self.get_profile_bool_value( 'snapshots.remove_old_snapshots.enabled', True, profile_id )
def get_remove_old_snapshots_date( self, profile_id = None ):
enabled, value, unit = self.get_remove_old_snapshots( profile_id )
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( day = 1, year = date.year - value )
return datetime.date( 1, 1, 1 )
def set_remove_old_snapshots( self, enabled, value, unit, profile_id = None ):
self.set_profile_bool_value( 'snapshots.remove_old_snapshots.enabled', enabled, profile_id )
self.set_profile_int_value( 'snapshots.remove_old_snapshots.value', value, profile_id )
self.set_profile_int_value( 'snapshots.remove_old_snapshots.unit', unit, profile_id )
def get_min_free_space( self, profile_id = None ):
#?Remove snapshots until \fIprofile<N>.snapshots.min_free_space.value\fR
#?free space is reached.
return ( self.get_profile_bool_value( 'snapshots.min_free_space.enabled', True, profile_id ),
#?Keep at least value + unit free space.;1-99999
self.get_profile_int_value( 'snapshots.min_free_space.value', 1, profile_id ),
#?10 = MB\n20 = GB;10|20;20
self.get_profile_int_value( 'snapshots.min_free_space.unit', self.DISK_UNIT_GB, profile_id ) )
def is_min_free_space_enabled( self, profile_id = None ):
return self.get_profile_bool_value( 'snapshots.min_free_space.enabled', True, profile_id )
def get_min_free_space_in_mb( self, profile_id = None ):
enabled, value, unit = self.get_min_free_space( profile_id )
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, profile_id = None ):
self.set_profile_bool_value( 'snapshots.min_free_space.enabled', enabled, profile_id )
self.set_profile_int_value( 'snapshots.min_free_space.value', value, profile_id )
self.set_profile_int_value( 'snapshots.min_free_space.unit', unit, profile_id )
def min_free_inodes(self, profile_id = None):
#?Keep at least value % free inodes.;1-15
return self.get_profile_int_value('snapshots.min_free_inodes.value', 2, profile_id)
def min_free_inodes_enabled(self, profile_id = None):
#?Remove snapshots until \fIprofile<N>.snapshots.min_free_inodes.value\fR
#?free inodes in % is reached.
return self.get_profile_bool_value('snapshots.min_free_inodes.enabled', True, profile_id)
def set_min_free_inodes(self, enabled, value, profile_id = None):
self.set_profile_bool_value('snapshots.min_free_inodes.enabled', enabled, profile_id)
self.set_profile_int_value('snapshots.min_free_inodes.value', value, profile_id)
def get_dont_remove_named_snapshots( self, profile_id = None ):
#?Keep snapshots with names during smart_remove.
return self.get_profile_bool_value( 'snapshots.dont_remove_named_snapshots', True, profile_id )
def set_dont_remove_named_snapshots( self, value, profile_id = None ):
self.set_profile_bool_value( 'snapshots.dont_remove_named_snapshots', value, profile_id )
def get_smart_remove( self, profile_id = None ):
#?Run smart_remove to clean up old snapshots after a new snapshot was created.
return ( self.get_profile_bool_value( 'snapshots.smart_remove', False, profile_id ),
#?Keep all snapshots for X days.
self.get_profile_int_value( 'snapshots.smart_remove.keep_all', 2, profile_id ),
#?Keep one snapshot per day for X days.
self.get_profile_int_value( 'snapshots.smart_remove.keep_one_per_day', 7, profile_id ),
#?Keep one snapshot per week for X weeks.
self.get_profile_int_value( 'snapshots.smart_remove.keep_one_per_week', 4, profile_id ),
#?Keep one snapshot per month for X month.
self.get_profile_int_value( 'snapshots.smart_remove.keep_one_per_month', 24, profile_id ) )
def set_smart_remove( self, value, keep_all, keep_one_per_day, keep_one_per_week, keep_one_per_month, profile_id = None ):
self.set_profile_bool_value( 'snapshots.smart_remove', value, profile_id )
self.set_profile_int_value( 'snapshots.smart_remove.keep_all', keep_all, profile_id )
self.set_profile_int_value( 'snapshots.smart_remove.keep_one_per_day', keep_one_per_day, profile_id )
self.set_profile_int_value( 'snapshots.smart_remove.keep_one_per_week', keep_one_per_week, profile_id )
self.set_profile_int_value( 'snapshots.smart_remove.keep_one_per_month', keep_one_per_month, profile_id )
def is_notify_enabled( self, profile_id = None ):
#?Display notifications (errors, warnings) through libnotify.
return self.get_profile_bool_value( 'snapshots.notify.enabled', True, profile_id )
def set_notify_enabled( self, value, profile_id = None ):
self.set_profile_bool_value( 'snapshots.notify.enabled', value, profile_id )
def is_backup_on_restore_enabled( self, profile_id = None ):
#?Rename existing files before restore into FILE.backup.YYYYMMDD
return self.get_profile_bool_value( 'snapshots.backup_on_restore.enabled', True, profile_id )
def set_backup_on_restore( self, value, profile_id = None ):
self.set_profile_bool_value( 'snapshots.backup_on_restore.enabled', value, profile_id )
def is_run_nice_from_cron_enabled( self, profile_id = None ):
#?Run cronjobs with 'nice -n 19'. This will give BackInTime the
#?lowest CPU priority to not interupt any other working process.\n
#?Note that the crontab entry is only generated during saving in
#?settings dialog. If you don't run a GUI version of BackInTime
#?you'll have to create the crontab entry on your own.
return self.get_profile_bool_value( 'snapshots.cron.nice', True, profile_id )
def set_run_nice_from_cron_enabled( self, value, profile_id = None ):
self.set_profile_bool_value( 'snapshots.cron.nice', value, profile_id )
def is_run_ionice_from_cron_enabled( self, profile_id = None ):
#?Run cronjobs with 'ionice -c2 -n7'. This will give BackInTime the
#?lowest IO bandwidth priority to not interupt any other working process.\n
#?Note that the crontab entry is only generated during saving in
#?settings dialog. If you don't run a GUI version of BackInTime
#?you'll have to create the crontab entry on your own.
return self.get_profile_bool_value( 'snapshots.cron.ionice', True, profile_id )
def set_run_ionice_from_cron_enabled( self, value, profile_id = None ):
self.set_profile_bool_value( 'snapshots.cron.ionice', value, profile_id )
def is_run_ionice_from_user_enabled( self, profile_id = None ):
#?Run BackInTime with 'ionice -c2 -n7' when taking a manual snapshot.
#?This will give BackInTime the lowest IO bandwidth priority to not
#?interupt any other working process.
return self.get_profile_bool_value( 'snapshots.user_backup.ionice', False, profile_id )
def set_run_ionice_from_user_enabled( self, value, profile_id = None ):
self.set_profile_bool_value( 'snapshots.user_backup.ionice', value, profile_id )
def is_run_nice_on_remote_enabled(self, profile_id = None):
#?Run rsync and other commands on remote host with 'nice -n 19'
return self.get_profile_bool_value('snapshots.ssh.nice', False, profile_id)
def set_run_nice_on_remote_enabled(self, value, profile_id = None):
self.set_profile_bool_value('snapshots.ssh.nice', value, profile_id)
def is_run_ionice_on_remote_enabled(self, profile_id = None):
#?Run rsync and other commands on remote host with 'ionice -c2 -n7'
return self.get_profile_bool_value('snapshots.ssh.ionice', False, profile_id)
def set_run_ionice_on_remote_enabled(self, value, profile_id = None):
self.set_profile_bool_value('snapshots.ssh.ionice', value, profile_id)
def bwlimit_enabled( self, profile_id = None ):
#?Limit rsync bandwidth usage over network. Use this with mode SSH.
#?For mode Local you should rather use ionice.
return self.get_profile_bool_value( 'snapshots.bwlimit.enabled', False, profile_id )
def set_bwlimit_enabled( self, value, profile_id = None ):
self.set_profile_bool_value( 'snapshots.bwlimit.enabled', value, profile_id )
def bwlimit( self, profile_id = None ):
#?Bandwidth limit in KB/sec.
return self.get_profile_int_value( 'snapshots.bwlimit.value', 3000, profile_id )
def set_bwlimit( self, value, profile_id = None ):
self.set_profile_int_value( 'snapshots.bwlimit.value', value, profile_id )
def is_no_on_battery_enabled( self, profile_id = None ):
#?Don't take snapshots if the Computer runs on battery.
return self.get_profile_bool_value( 'snapshots.no_on_battery', False, profile_id )
def set_no_on_battery_enabled( self, value, profile_id = None ):
self.set_profile_bool_value( 'snapshots.no_on_battery', value, profile_id )
def preserve_acl( self, profile_id = None ):
#?Preserve ACL. The source and destination systems must have
#?compatible ACL entries for this option to work properly.
return self.get_profile_bool_value( 'snapshots.preserve_acl', False, profile_id )
def set_preserve_acl( self, value, profile_id = None ):
return self.set_profile_bool_value( 'snapshots.preserve_acl', value, profile_id )
def preserve_xattr( self, profile_id = None ):
#?Preserve extended attributes (xattr).
return self.get_profile_bool_value( 'snapshots.preserve_xattr', False, profile_id )
def set_preserve_xattr( self, value, profile_id = None ):
return self.set_profile_bool_value( 'snapshots.preserve_xattr', value, profile_id )
def copy_unsafe_links( self, profile_id = None ):
#?This tells rsync to copy the referent of symbolic links that point
#?outside the copied tree. Absolute symlinks are also treated like
#?ordinary files.
return self.get_profile_bool_value( 'snapshots.copy_unsafe_links', False, profile_id )
def set_copy_unsafe_links( self, value, profile_id = None ):
return self.set_profile_bool_value( 'snapshots.copy_unsafe_links', value, profile_id )
def copy_links( self, profile_id = None ):
#?When symlinks are encountered, the item that they point to
#?(the referent) is copied, rather than the symlink.
return self.get_profile_bool_value( 'snapshots.copy_links', False, profile_id )
def set_copy_links( self, value, profile_id = None ):
return self.set_profile_bool_value( 'snapshots.copy_links', value, profile_id )
def continue_on_errors( self, profile_id = None ):
#?Continue on errors. This will keep incomplete snapshots rather than
#?deleting and start over again.
return self.get_profile_bool_value( 'snapshots.continue_on_errors', True, profile_id )
def set_continue_on_errors( self, value, profile_id = None ):
return self.set_profile_bool_value( 'snapshots.continue_on_errors', value, profile_id )
def use_checksum( self, profile_id = None ):
#?Use checksum to detect changes rather than size + time.
return self.get_profile_bool_value( 'snapshots.use_checksum', False, profile_id )
def set_use_checksum( self, value, profile_id = None ):
return self.set_profile_bool_value( 'snapshots.use_checksum', value, profile_id )
def log_level( self, profile_id = None ):
#?Log level used during take_snapshot.\n1 = Error\n2 = Changes\n3 = Info;1-3
return self.get_profile_int_value( 'snapshots.log_level', 3, profile_id )
def set_log_level( self, value, profile_id = None ):
return self.set_profile_int_value( 'snapshots.log_level', value, profile_id )
def full_rsync( self, profile_id = None ):
#?Full rsync mode. May be faster but snapshots are not read-only
#?anymore and destination file-system must support all linux
#?attributes (date, rights, user, group...)
return self.get_profile_bool_value( 'snapshots.full_rsync', False, profile_id )
def set_full_rsync( self, value, profile_id = None ):
return self.set_profile_bool_value( 'snapshots.full_rsync', value, profile_id )
def check_for_changes( self, profile_id = None ):
#?Perform a dry-run before taking snapshots. Don't take a new snapshot
#?if nothing has changed.
return self.get_profile_bool_value( 'snapshots.check_for_changes', True, profile_id )
def set_check_for_changes( self, value, profile_id = None ):
return self.set_profile_bool_value( 'snapshots.check_for_changes', value, profile_id )
def gnu_find_suffix_support( self, profile_id = None ):
#?Remote SSH host support GNU find suffix (find -exec COMMAND {} +).
return self.get_profile_bool_value( 'snapshots.gnu_find_suffix_support', True, profile_id )
def find_suffix( self, profile_id = None ):
if self.gnu_find_suffix_support(profile_id):
return '+'
else:
return '\\;'
def set_gnu_find_suffix_support( self, value, profile_id = None ):
return self.set_profile_bool_value( 'snapshots.gnu_find_suffix_support', value, profile_id )
def get_take_snapshot_user_script( self, step, profile_id = None ):
#?Run this scrip on events defined by <STEP>.\nPossible events for
#?<STEP>:\n before\n after\n new_snapshot\n error;absolute path
return self.get_profile_str_value ( "snapshots.take_snapshot.%s.user.script" % step, '', profile_id )
def set_take_snapshot_user_script( self, step, path, profile_id = None ):
self.set_profile_str_value( "snapshots.take_snapshot.%s.user.script" % step, path, profile_id )
def get_take_snapshot_user_script_before( self, profile_id = None ):
return self.get_take_snapshot_user_script( 'before', profile_id )
def set_take_snapshot_user_script_before( self, path, profile_id = None ):
self.set_take_snapshot_user_script( 'before', path, profile_id )
def get_take_snapshot_user_script_after( self, profile_id = None ):
return self.get_take_snapshot_user_script( 'after', profile_id )
def set_take_snapshot_user_script_after( self, path, profile_id = None ):
self.set_take_snapshot_user_script( 'after', path, profile_id )
def get_take_snapshot_user_script_new_snapshot( self, profile_id = None ):
return self.get_take_snapshot_user_script( 'new_snapshot', profile_id = None )
def set_take_snapshot_user_script_new_snapshot( self, path, profile_id = None ):
self.set_take_snapshot_user_script( 'new_snapshot', path, profile_id )
def get_take_snapshot_user_script_error( self, profile_id = None ):
return self.get_take_snapshot_user_script( 'error', profile_id )
def set_take_snapshot_user_script_error( self, path, profile_id = None ):
self.set_take_snapshot_user_script( 'error', path, profile_id )
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_file_id__( self, profile_id = None ):
if profile_id is None:
profile_id = self.get_current_profile()
if profile_id == '1':
return ''
return profile_id
def get_take_snapshot_log_file( self, profile_id = None ):
return os.path.join( self._LOCAL_DATA_FOLDER, "takesnapshot_%s.log" % self.__get_file_id__( profile_id ) )
def get_take_snapshot_message_file( self, profile_id = None ):
return os.path.join( self._LOCAL_DATA_FOLDER, "worker%s.message" % self.__get_file_id__( profile_id ) )
def get_take_snapshot_instance_file( self, profile_id = None ):
return os.path.join( self._LOCAL_DATA_FOLDER, "worker%s.lock" % self.__get_file_id__( profile_id ) )
#def get_last_snapshot_info_file( self, profile_id = None ):
# return os.path.join( self._LOCAL_DATA_FOLDER, "snapshot%s.last" % self.__get_file_id__( profile_id ) )
def get_take_snapshot_user_callback( self, profile_id = None ):
return os.path.join( self._LOCAL_CONFIG_FOLDER, "user-callback" )
def get_password_cache_folder( self ):
return os.path.join( self._LOCAL_DATA_FOLDER, "password_cache" )
def get_password_cache_pid( self ):
return os.path.join( self.get_password_cache_folder(), "PID" )
def get_password_cache_fifo( self ):
return os.path.join( self.get_password_cache_folder(), "FIFO" )
def get_password_cache_info( self ):
return os.path.join( self.get_password_cache_folder(), "info" )
def get_cron_env_file( self ):
return os.path.join( self._LOCAL_DATA_FOLDER, "cron_env" )
def get_anacrontab(self, suffix = ''):
return os.path.join(self._LOCAL_CONFIG_FOLDER, 'anacrontab' + suffix)
def get_anacron_spool(self):
return os.path.join(self._LOCAL_DATA_FOLDER, 'anacron')
def get_udev_rules_path(self):
return os.path.join('/etc/udev/rules.d', '99-backintime-%s.rules' % self.get_user())
def get_restore_log_file( self, profile_id = None ):
return os.path.join( self._LOCAL_DATA_FOLDER, "restore_%s.log" % self.__get_file_id__( profile_id ) )
def get_last_snapshot_symlink(self, profile_id = None):
return os.path.join(self.get_snapshots_full_path(profile_id), 'last_snapshot')
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, profile_id = None ):
'''Checks if the program is configured'''
if len( self.get_snapshots_path( profile_id ) ) == 0:
return False
if len( self.get_include( profile_id ) ) == 0:
return False
return True
def can_backup( self, profile_id = None ):
'''Checks if snapshots_path exists'''
if not self.is_configured( profile_id ):
return False
if not os.path.isdir( self.get_snapshots_full_path( profile_id ) ):
print("%s does not exist" % self.get_snapshots_full_path( profile_id ))
return False
return True
def setup_cron( self ):
system_entry_message = "#Back In Time system entry, this will be edited by the gui:"
"""We have to check if the system_entry_message is in use,
if not then the entries are most likely from Back In Time 0.9.26
or earlier."""
if os.system( "crontab -l | grep '%s' > /dev/null" % system_entry_message ) != 0:
"""Then the system entry message has not yet been used in this crontab
therefore we assume all entries are system entries and clear them all.
This is the old behaviour"""
print("Clearing all Back In Time entries")
os.system( "crontab -l | grep -v backintime | crontab -" )
print("Clearing system Back In Time entries")
#os.system( "crontab -l | grep -Pv '(?s)%s.*?backintime' | crontab -" % system_entry_message ) #buggy in Ubuntu 10.10
os.system( "crontab -l | sed '/%s/{N;/backintime/d;}' | crontab -" % system_entry_message )
print("Clearing anacrontab")
dirname, basename = os.path.split(self.get_anacrontab())
for file in os.listdir(dirname):
if file.startswith(basename):
os.remove(os.path.join(dirname, file))
empty = True
start_anacron = False
uuid_tmp_fd = None
uuids = []
profiles = self.get_profiles()
try:
for profile_id in profiles:
profile_name = self.get_profile_name( profile_id )
print("Profile: %s" % profile_name)
backup_mode = self.get_automatic_backup_mode( profile_id )
print("Automatic backup: %s" % self.AUTOMATIC_BACKUP_MODES[ backup_mode ])
if self.NONE == backup_mode:
continue
if not tools.check_command( 'crontab' ):
self.notify_error( _( 'Can\'t find crontab.\nAre you sure cron is installed ?\nIf not you should disable all automatic backups.' ) )
return False
cron_line = ''
anacron_line = ''
hour = self.get_automatic_backup_time(profile_id) / 100;
minute = self.get_automatic_backup_time(profile_id) % 100;
day = self.get_automatic_backup_day(profile_id)
weekday = self.get_automatic_backup_weekday(profile_id)
period = str(self.get_automatic_backup_anacron_period(profile_id))
job_identify = profile_id + '_' + profile_name.replace(' ', '_')
if self.AT_EVERY_BOOT == backup_mode:
cron_line = 'echo "{msg}\n@reboot {cmd}"'
elif self._5_MIN == backup_mode:
cron_line = 'echo "{msg}\n*/5 * * * * {cmd}"'
elif self._10_MIN == backup_mode:
cron_line = 'echo "{msg}\n*/10 * * * * {cmd}"'
elif self._30_MIN == backup_mode:
cron_line = 'echo "{msg}\n*/30 * * * * {cmd}"'
elif self._1_HOUR == backup_mode:
cron_line = 'echo "{msg}\n0 * * * * {cmd}"'
elif self._2_HOURS == backup_mode:
cron_line = 'echo "{msg}\n0 */2 * * * {cmd}"'
elif self._4_HOURS == backup_mode:
cron_line = 'echo "{msg}\n0 */4 * * * {cmd}"'
elif self._6_HOURS == backup_mode:
cron_line = 'echo "{msg}\n0 */6 * * * {cmd}"'
elif self._12_HOURS == backup_mode:
cron_line = 'echo "{msg}\n0 */12 * * * {cmd}"'
elif self.CUSTOM_HOUR == backup_mode:
cron_line = 'echo "{msg}\n0 ' + self.get_custom_backup_time( profile_id ) + ' * * * {cmd}"'
elif self.DAY == backup_mode:
cron_line = "echo \"{msg}\n%s %s * * * {cmd}\"" % (minute, hour)
elif self.DAY_ANACRON == backup_mode:
if not self.check_anacron():
return False
anacrontab_suffix = ''
if not start_anacron:
cron_line = 'echo "{msg}\n*/15 * * * * %s"' % self.anacron_cmd(anacrontab_suffix)
start_anacron = True
anacron_line = '\t'.join((period, '0', job_identify, '{cmd}')) + '\n'
elif self.UDEV == backup_mode:
if not self.check_anacron():
return False
mode = self.get_snapshots_mode(profile_id)
if mode == 'local':
dest_path = self.get_snapshots_full_path(profile_id)
elif mode == 'local_encfs':
dest_path = self.get_local_encfs_path(profile_id)
else:
self.notify_error( _('Schedule udev doesn\'t work with mode %s') % mode)
return False
uuid = tools.get_uuid_from_path(dest_path)
if uuid is None:
self.notify_error( _('Couldn\'t find UUID for "%s"') % dest_path)
return False
if uuid_tmp_fd is None:
uuid_tmp_fd = tempfile.NamedTemporaryFile()
anacrontab_suffix = '-%s' % uuid
anacron_line = '\t'.join((period, '0', job_identify, '{cmd}')) + '\n'
if not uuid in uuids:
self.prepair_udev(uuid_tmp_fd, uuid, anacrontab_suffix)
uuids += uuid
elif self.WEEK == backup_mode:
cron_line = "echo \"{msg}\n%s %s * * %s {cmd}\"" % (minute, hour, weekday)
elif self.MONTH == backup_mode:
cron_line = "echo \"{msg}\n%s %s %s * * {cmd}\"" % (minute, hour, day)
cmd = self.cron_cmd(profile_id)
if len( cron_line ) > 0:
empty = False
cron_line = cron_line.replace( '{cmd}', cmd )
cron_line = cron_line.replace( '{msg}', system_entry_message )
os.system( "( crontab -l; %s ) | crontab -" % cron_line )
if len(anacron_line) > 0:
anacron_line = anacron_line.replace('{cmd}', cmd)
tools.make_dirs(self.get_anacron_spool())
env = ''
if not os.path.exists(self.get_anacrontab(anacrontab_suffix)):
env = 'SHELL=%s\n' % os.environ['SHELL']
env += 'PATH=%s\n' % os.environ['PATH']
env += 'DISPLAY=%s\n' % os.environ['DISPLAY']
env += '\n\n'
with open(self.get_anacrontab(anacrontab_suffix), 'a') as f:
f.write(env)
f.write(anacron_line)
if uuid_tmp_fd is None:
if not self.remove_udev():
self.notify_error( _('Failed to remove udev rules') )
else:
uuid_tmp_fd.flush()
uuid_tmp_fd.seek(0)
if len(uuid_tmp_fd.read()) > 0:
if not self.setup_udev(uuid_tmp_fd):
self.notify_error( _('Failed to create udev rules') )
uuid_tmp_fd.close()
return False
uuid_tmp_fd.close()
except:
raise
finally:
if empty:
# Leave one system_entry_message in to prevent deleting of manual
# entries if there is no automatic entry.
info_message = "#Please don't delete these two lines, or all custom backintime entries are going to be deleted next time you call the gui options!"
os.system( '(crontab -l; echo "%s"; echo "%s") | crontab -'
% (system_entry_message, info_message) )
return True
def cron_cmd(self, profile_id):
cmd = tools.which('backintime') + ' '
if profile_id != '1':
cmd += '--profile-id %s ' % profile_id
if not self._LOCAL_CONFIG_PATH is self._DEFAULT_CONFIG_PATH:
cmd += '--config %s ' % self._LOCAL_CONFIG_PATH
cmd += '--backup-job >/dev/null 2>&1'
if self.is_run_ionice_from_cron_enabled(profile_id) and tools.check_command('ionice'):
cmd = tools.which('ionice') + ' -c2 -n7 ' + cmd
if self.is_run_nice_from_cron_enabled( profile_id ) and tools.check_command('nice'):
cmd = tools.which('nice') + ' -n 19 ' + cmd
return cmd
def anacron_cmd(self, suffix = ''):
return 'test -x %(cmd)s && test -e %(tab)s && %(cmd)s -s -t %(tab)s -S %(spool)s' \
% {'cmd': tools.which('anacron'),
'tab': self.get_anacrontab(suffix),
'spool': self.get_anacron_spool()}
def check_anacron(self):
if tools.check_command('anacron'):
return True
self.notify_error( _( 'Can\'t find anacron.\nAre you sure anacron is installed ?\nIf not you should disable daily anacron backups.' ) )
return False
def prepair_udev(self, tmp_fd, uuid, anacrontab_suffix):
cmd = self.anacron_cmd(anacrontab_suffix)
cmd = "%s - '%s' -c '%s' &" %(tools.which('su'), self.get_user(), cmd)
tmp_fd.write('ACTION=="add", ENV{ID_FS_UUID}=="%s", RUN+="%s"\n' %(uuid, cmd))
return True
def setup_udev(self, tmp_fd):
tmp_fd.flush()
path = self.get_udev_rules_path()
os.chmod(tmp_fd.name, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP | stat.S_IROTH)
try:
if os.path.exists(path) and tools._get_md5sum_from_path(tmp_fd.name) == tools._get_md5sum_from_path(path):
return True
except TypeError:
pass
cmd = 'cp "%s" "%s"' %(tmp_fd.name, path)
return tools.sudo_execute(self, cmd, _('Please provide your sudo password to install the udev rule.')) == 0
def remove_udev(self):
if not os.path.exists(self.get_udev_rules_path()):
return True
cmd = 'rm %s' % self.get_udev_rules_path()
return tools.sudo_execute(self, cmd, _('Please provide your sudo password to remove unused udev rules.')) == 0
#def get_update_other_folders( self ):
# return self.get_bool_value( 'update.other_folders', True )
#def set_update_other_folders( self, value ):
# self.set_bool_value( 'update.other_folders', value )
if __name__ == "__main__":
config = Config()
print("snapshots path = %s" % config.get_snapshots_full_path())
|