Add new function: unprotect_workbook (#26)

Author: Laolaowwu

excelize.py

@@ -5096,6 +5096,27 @@ def unprotect_sheet(self, sheet: str, *password: str) -> None:
         if err != "":
             raise RuntimeError(err)
 
+    def unprotect_workbook(self, *password: str) -> None:
+        """
+        Remove protection for workbook, specified the optional password
+        parameter to remove workbook protection with password verification.
+
+        Args:
+            *password (str): Optional password for workbook protection
+            verification
+
+        Returns:
+            None: Return None if no error occurred, otherwise raise a
+            RuntimeError with the message.
+        """
+        lib.UnprotectWorkbook.restype = c_char_p
+        passwd = password[0] if len(password) > 0 else ""
+        err = lib.UnprotectWorkbook(
+            self.file_index, passwd.encode(ENCODE), len(password) > 0
+        ).decode(ENCODE)
+        if err != "":
+            raise RuntimeError(err)
+
     def update_linked_value(self) -> None:
         """
         Fix linked values within a spreadsheet are not updating in Office Excel

main.go

@@ -2785,6 +2785,28 @@ func UnprotectSheet(idx int, sheet, password *C.char, verify bool) *C.char {
 	return C.CString(emptyString)
 }
 
+// UnprotectWorkbook provides a function to remove protection for workbook,
+// specified the optional password parameter to remove workbook protection with
+// password verification.
+//
+//export UnprotectWorkbook
+func UnprotectWorkbook(idx int, password *C.char, verify bool) *C.char {
+	f, ok := files.Load(idx)
+	if !ok {
+		return C.CString(errFilePtr)
+	}
+	if verify {
+		if err := f.(*excelize.File).UnprotectWorkbook(C.GoString(password)); err != nil {
+			return C.CString(err.Error())
+		}
+		return C.CString(emptyString)
+	}
+	if err := f.(*excelize.File).UnprotectWorkbook(); err != nil {
+		return C.CString(err.Error())
+	}
+	return C.CString(emptyString)
+}
+
 // UpdateLinkedValue fix linked values within a spreadsheet are not updating in
 // Office Excel application. This function will be remove value tag when met a
 // cell have a linked value.

test_excelize.py

@@ -468,6 +468,11 @@ def test_style(self):
                 )
             )
         )
+        with self.assertRaises(RuntimeError) as context:
+            f.unprotect_workbook("")
+        self.assertEqual(str(context.exception), "password length invalid")
+        self.assertIsNone(f.unprotect_workbook("password"))
+        self.assertIsNone(f.unprotect_workbook())
         self.assertIsNone(f.move_sheet("Sheet2", "Sheet1"))
         with self.assertRaises(RuntimeError) as context:
             f.move_sheet("SheetN", "Sheet1")
@@ -1569,15 +1574,15 @@ def test_sheet_visible(self):
             f.set_sheet_visible("Sheet:1", False, True)
         self.assertEqual(
             str(context.exception),
-            "the sheet can not contain any of the characters :\/?*[or]",
+            "the sheet can not contain any of the characters :\\/?*[or]",
         )
         self.assertTrue(f.get_sheet_visible("Sheet1"))
         self.assertFalse(f.get_sheet_visible("Sheet2"))
         with self.assertRaises(RuntimeError) as context:
             f.get_sheet_visible("Sheet:1")
         self.assertEqual(
             str(context.exception),
-            "the sheet can not contain any of the characters :\/?*[or]",
+            "the sheet can not contain any of the characters :\\/?*[or]",
         )
         self.assertIsNone(f.save_as(os.path.join("test", "TestSheetVisible.xlsx")))
         self.assertIsNone(f.close())