feat: remove useless functionality

frappe/integrations/doctype/s3_backup_settings/s3_backup_settings.json

@@ -18,12 +18,9 @@
   "bucket",
   "endpoint_url",
   "column_break_13",
-  "region",
   "backup_details_section",
   "frequency",
-  "backup_files",
-  "column_break_18",
-  "backup_limit"
+  "backup_files"
  ],
  "fields": [
   {
@@ -42,7 +39,7 @@
   },
   {
    "default": "1",
-   "description": "Note: By default emails for failed backups are sent.",
+   "description": "By default, emails are only sent for failed backups.",
    "fieldname": "send_email_for_successful_backup",
    "fieldtype": "Check",
    "label": "Send Email for Successful Backup"
@@ -73,14 +70,7 @@
    "reqd": 1
   },
   {
-   "default": "us-east-1",
-   "description": "See https://docs.aws.amazon.com/general/latest/gr/s3.html for details.",
-   "fieldname": "region",
-   "fieldtype": "Select",
-   "label": "Region",
-   "options": "us-east-1\nus-east-2\nus-west-1\nus-west-2\naf-south-1\nap-east-1\nap-south-1\nap-southeast-1\nap-southeast-2\nap-northeast-1\nap-northeast-2\nap-northeast-3\nca-central-1\ncn-north-1\ncn-northwest-1\neu-central-1\neu-west-1\neu-west-2\neu-west-3\neu-south-1\neu-north-1\nme-south-1\nsa-east-1"
-  },
-  {
+   "default": "https://s3.amazonaws.com",
    "fieldname": "endpoint_url",
    "fieldtype": "Data",
    "label": "Endpoint URL"
@@ -92,14 +82,6 @@
    "mandatory_depends_on": "enabled",
    "reqd": 1
   },
-  {
-   "description": "Set to 0 for no limit on the number of backups taken",
-   "fieldname": "backup_limit",
-   "fieldtype": "Int",
-   "label": "Backup Limit",
-   "mandatory_depends_on": "enabled",
-   "reqd": 1
-  },
   {
    "depends_on": "enabled",
    "fieldname": "api_access_section",
@@ -142,16 +124,12 @@
    "fieldname": "backup_files",
    "fieldtype": "Check",
    "label": "Backup Files"
-  },
-  {
-   "fieldname": "column_break_18",
-   "fieldtype": "Column Break"
   }
  ],
  "hide_toolbar": 1,
  "issingle": 1,
  "links": [],
- "modified": "2020-07-27 17:27:21.400000",
+ "modified": "2020-12-07 15:30:55.047689",
  "modified_by": "Administrator",
  "module": "Integrations",
  "name": "S3 Backup Settings",
@@ -172,4 +150,4 @@
  "sort_field": "modified",
  "sort_order": "DESC",
  "track_changes": 1
-}
+}

frappe/integrations/doctype/s3_backup_settings/s3_backup_settings.py

@@ -24,6 +24,7 @@ class S3BackupSettings(Document):
 
 		if not self.endpoint_url:
 			self.endpoint_url = 'https://s3.amazonaws.com'
+
 		conn = boto3.client(
 			's3',
 			aws_access_key_id=self.access_key_id,
@@ -31,25 +32,21 @@ class S3BackupSettings(Document):
 			endpoint_url=self.endpoint_url
 		)
 
-		bucket_lower = str(self.bucket)
-
-		try:
-			conn.list_buckets()
-
-		except ClientError:
-			frappe.throw(_("Invalid Access Key ID or Secret Access Key."))
-
 		try:
 			# Head_bucket returns a 200 OK if the bucket exists and have access to it.
-			conn.head_bucket(Bucket=bucket_lower)
+			# Requires ListBucket permission
+			conn.head_bucket(Bucket=self.bucket)
 		except ClientError as e:
 			error_code = e.response['Error']['Code']
+			bucket_name = frappe.bold(self.bucket)
 			if error_code == '403':
-				frappe.throw(_("Do not have permission to access {0} bucket.").format(bucket_lower))
-			else:   # '400'-Bad request or '404'-Not Found return
-				# try to create bucket
-				conn.create_bucket(Bucket=bucket_lower, CreateBucketConfiguration={
-					'LocationConstraint': self.region})
+				msg = _("Do not have permission to access bucket {0}.").format(bucket_name)
+			elif error_code == '404':
+				msg = _("Bucket {0} not found.").format(bucket_name)
+			else:
+				msg = e.args[0]
+
+			frappe.throw(msg)
 
 
 @frappe.whitelist()
@@ -70,11 +67,13 @@ def take_backups_weekly():
 def take_backups_monthly():
 	take_backups_if("Monthly")
 
+
 def take_backups_if(freq):
 	if cint(frappe.db.get_value("S3 Backup Settings", None, "enabled")):
 		if frappe.db.get_value("S3 Backup Settings", None, "frequency") == freq:
 			take_backups_s3()
 
+
 @frappe.whitelist()
 def take_backups_s3(retry_count=0):
 	try:
@@ -146,42 +145,13 @@ def backup_to_s3():
 		if files_filename:
 			upload_file_to_s3(files_filename, folder, conn, bucket)
 
-	delete_old_backups(doc.backup_limit, bucket)
-
 
 def upload_file_to_s3(filename, folder, conn, bucket):
 	destpath = os.path.join(folder, os.path.basename(filename))
 	try:
 		print("Uploading file:", filename)
-		conn.upload_file(filename, bucket, destpath)
+		conn.upload_file(filename, bucket, destpath) # Requires PutObject permission
 
 	except Exception as e:
 		frappe.log_error()
 		print("Error uploading: %s" % (e))
-
-
-def delete_old_backups(limit, bucket):
-	all_backups = []
-	doc = frappe.get_single("S3 Backup Settings")
-	backup_limit = int(limit)
-
-	s3 = boto3.resource(
-			's3',
-			aws_access_key_id=doc.access_key_id,
-			aws_secret_access_key=doc.get_password('secret_access_key'),
-			endpoint_url=doc.endpoint_url or 'https://s3.amazonaws.com'
-		)
-
-	bucket = s3.Bucket(bucket)
-	objects = bucket.meta.client.list_objects_v2(Bucket=bucket.name, Delimiter='/')
-	if objects:
-		for obj in objects.get('CommonPrefixes'):
-			all_backups.append(obj.get('Prefix'))
-
-	oldest_backup = sorted(all_backups)[0] if all_backups else ''
-
-	if len(all_backups) > backup_limit:
-		print("Deleting Backup: {0}".format(oldest_backup))
-		for obj in bucket.objects.filter(Prefix=oldest_backup):
-			# delete all keys that are inside the oldest_backup
-			s3.Object(bucket.name, obj.key).delete()