This closes qax-os#2133, support delete data validations in the ext list (qax-os#2137)

- Support delete data validation by given with multiple cell ranges with reference sequence slice or blank separated reference sequence string
- Update unit tests

Author: DengY11

datavalidation.go

@@ -12,9 +12,11 @@
 package excelize
 
 import (
+	"encoding/xml"
 	"fmt"
 	"io"
 	"math"
+	"slices"
 	"strings"
 	"unicode/utf16"
 )
@@ -361,27 +363,59 @@ func getDataValidations(dvs *xlsxDataValidations) []*DataValidation {
 }
 
 // DeleteDataValidation delete data validation by given worksheet name and
-// reference sequence. This function is concurrency safe.
-// All data validations in the worksheet will be deleted
-// if not specify reference sequence parameter.
+// reference sequence. This function is concurrency safe. All data validations
+// in the worksheet will be deleted if not specify reference sequence parameter.
+//
+// Example 1, delete data validation on Sheet1!A1:B2:
+//
+//	err := f.DeleteDataValidation("Sheet1", "A1:B2")
+//
+// Example 2, delete data validations on Sheet1 with multiple cell ranges
+// A1:B2 and C1:C3 with reference sequence slice:
+//
+//	err := f.DeleteDataValidation("Sheet1", []string{"A1:B2", "C1:C3"}...)
+//
+// Example 3, delete data validations on Sheet1 with multiple cell ranges
+// A1:B2 and C1:C3 with blank separated reference sequence string, the result
+// same as example 2:
+//
+//	err := f.DeleteDataValidation("Sheet1", "A1:B2 C1:C3")
+//
+// Example 4, delete all data validations on Sheet1:
+//
+//	err := f.DeleteDataValidation("Sheet1")
 func (f *File) DeleteDataValidation(sheet string, sqref ...string) error {
 	ws, err := f.workSheetReader(sheet)
 	if err != nil {
 		return err
 	}
 	ws.mu.Lock()
 	defer ws.mu.Unlock()
-	if ws.DataValidations == nil {
+	if ws.DataValidations == nil && ws.ExtLst == nil {
 		return nil
 	}
 	if sqref == nil {
 		ws.DataValidations = nil
 		return nil
 	}
-	delCells, err := flatSqref(sqref[0])
+	delCells, err := flatSqref(strings.Join(sqref, " "))
 	if err != nil {
 		return err
 	}
+	if ws.DataValidations != nil {
+		if err = f.deleteDataValidation(ws, delCells); err != nil {
+			return err
+		}
+	}
+	if ws.ExtLst != nil {
+		return f.deleteX14DataValidation(ws, sqref)
+	}
+	return nil
+}
+
+// deleteDataValidation deletes data validation by given worksheet and cell
+// reference list.
+func (f *File) deleteDataValidation(ws *xlsxWorksheet, delCells map[int][][]int) error {
 	dv := ws.DataValidations
 	for i := 0; i < len(dv.DataValidation); i++ {
 		var applySqref []string
@@ -413,6 +447,64 @@ func (f *File) DeleteDataValidation(sheet string, sqref ...string) error {
 	return nil
 }
 
+// deleteX14DataValidation deletes data validation in the extLst element by
+// given worksheet and cell reference list.
+func (f *File) deleteX14DataValidation(ws *xlsxWorksheet, sqref []string) error {
+	var (
+		decodeExtLst          = new(decodeExtLst)
+		decodeDataValidations *xlsxDataValidations
+		x14DataValidations    *xlsxX14DataValidations
+	)
+	if err := f.xmlNewDecoder(strings.NewReader("<extLst>" + ws.ExtLst.Ext + "</extLst>")).
+		Decode(decodeExtLst); err != nil && err != io.EOF {
+		return err
+	}
+	for i, ext := range decodeExtLst.Ext {
+		if ext.URI == ExtURIDataValidations {
+			decodeDataValidations = new(xlsxDataValidations)
+			x14DataValidations = new(xlsxX14DataValidations)
+			_ = f.xmlNewDecoder(strings.NewReader(ext.Content)).Decode(decodeDataValidations)
+			x14DataValidations.XMLNSXM = NameSpaceSpreadSheetExcel2006Main.Value
+			x14DataValidations.DisablePrompts = decodeDataValidations.DisablePrompts
+			x14DataValidations.XWindow = decodeDataValidations.XWindow
+			x14DataValidations.YWindow = decodeDataValidations.YWindow
+			for _, dv := range decodeDataValidations.DataValidation {
+				if inStrSlice(sqref, dv.XMSqref, false) == -1 {
+					x14DataValidations.DataValidation = append(x14DataValidations.DataValidation, &xlsxX14DataValidation{
+						AllowBlank:       dv.AllowBlank,
+						Error:            dv.Error,
+						ErrorStyle:       dv.ErrorStyle,
+						ErrorTitle:       dv.ErrorTitle,
+						Operator:         dv.Operator,
+						Prompt:           dv.Prompt,
+						PromptTitle:      dv.PromptTitle,
+						ShowDropDown:     dv.ShowDropDown,
+						ShowErrorMessage: dv.ShowErrorMessage,
+						ShowInputMessage: dv.ShowInputMessage,
+						Sqref:            dv.Sqref,
+						XMSqref:          dv.XMSqref,
+						Type:             dv.Type,
+						Formula1:         dv.Formula1,
+						Formula2:         dv.Formula2,
+					})
+				}
+			}
+			x14DataValidations.Count = len(x14DataValidations.DataValidation)
+			x14DataValidationsBytes, _ := xml.Marshal(x14DataValidations)
+			decodeExtLst.Ext[i] = &xlsxExt{
+				xmlns: []xml.Attr{{Name: xml.Name{Local: "xmlns:" + NameSpaceSpreadSheetX14.Name.Local}, Value: NameSpaceSpreadSheetX14.Value}},
+				URI:   ExtURIDataValidations, Content: string(x14DataValidationsBytes),
+			}
+			if x14DataValidations.Count == 0 {
+				decodeExtLst.Ext = slices.Delete(decodeExtLst.Ext, i, i+1)
+			}
+		}
+	}
+	extLstBytes, err := xml.Marshal(decodeExtLst)
+	ws.ExtLst = &xlsxExtLst{Ext: strings.TrimSuffix(strings.TrimPrefix(string(extLstBytes), "<extLst>"), "</extLst>")}
+	return err
+}
+
 // squashSqref generates cell reference sequence by given cells coordinates list.
 func squashSqref(cells [][]int) []string {
 	if len(cells) == 1 {

datavalidation_test.go

@@ -16,6 +16,7 @@ import (
 	"math"
 	"path/filepath"
 	"strings"
+	"sync"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -242,4 +243,31 @@ func TestDeleteDataValidation(t *testing.T) {
 	// Test delete all data validations in the worksheet
 	assert.NoError(t, f.DeleteDataValidation("Sheet1"))
 	assert.Nil(t, ws.(*xlsxWorksheet).DataValidations)
+
+	t.Run("delete_data_validation_from_extLst", func(t *testing.T) {
+		f := NewFile()
+		f.Sheet.Delete("xl/worksheets/sheet1.xml")
+		f.Pkg.Store("xl/worksheets/sheet1.xml", fmt.Appendf(nil,
+			`<worksheet xmlns="%s"><sheetData/><extLst><ext xmlns:x14="%s" uri="%s"><x14:dataValidations xmlns:xm="%s" count="2"><x14:dataValidation allowBlank="true" showErrorMessage="true" showInputMessage="true" sqref="" type="list"><xm:sqref>A1:A2</xm:sqref><x14:formula1><xm:f>Sheet1!$A$2:$A$4</xm:f></x14:formula1></x14:dataValidation><x14:dataValidation allowBlank="true" showErrorMessage="true" showInputMessage="true" sqref="" type="list"><xm:sqref>B1:B2</xm:sqref><x14:formula1><xm:f>Sheet1!$B$2:$B$3</xm:f></x14:formula1></x14:dataValidation></x14:dataValidations></ext></extLst></worksheet>`,
+			NameSpaceSpreadSheet.Value, NameSpaceSpreadSheetExcel2006Main.Value,
+			ExtURIDataValidations, NameSpaceSpreadSheetExcel2006Main.Value))
+		f.checked = sync.Map{}
+		assert.NoError(t, f.DeleteDataValidation("Sheet1", "A1:A2"))
+		dvs, err := f.GetDataValidations("Sheet1")
+		assert.NoError(t, err)
+		assert.Len(t, dvs, 1)
+		assert.Equal(t, "B1:B2", dvs[0].Sqref)
+
+		assert.NoError(t, f.DeleteDataValidation("Sheet1", "B1:B2"))
+		dvs, err = f.GetDataValidations("Sheet1")
+		assert.NoError(t, err)
+		assert.Empty(t, dvs)
+	})
+
+	t.Run("delete_data_validation_failed_from_extLst", func(t *testing.T) {
+		f := NewFile()
+		assert.EqualError(t, f.deleteX14DataValidation(&xlsxWorksheet{
+			ExtLst: &xlsxExtLst{Ext: "<extLst><x14:dataValidations></x14:dataValidation></x14:dataValidations></ext></extLst>"},
+		}, nil), "XML syntax error on line 1: element <dataValidations> closed by </dataValidation>")
+	})
 }

xmlWorksheet.go

@@ -448,6 +448,39 @@ type xlsxDataValidation struct {
 	Formula2         *xlsxInnerXML `xml:"formula2"`
 }
 
+// xlsxX14DataValidation directly maps the single item of data validation
+// defined on a extLst element of the worksheet.
+type xlsxX14DataValidation struct {
+	XMLName          xml.Name      `xml:"x14:dataValidation"`
+	AllowBlank       bool          `xml:"allowBlank,attr"`
+	Error            *string       `xml:"error,attr"`
+	ErrorStyle       *string       `xml:"errorStyle,attr"`
+	ErrorTitle       *string       `xml:"errorTitle,attr"`
+	Operator         string        `xml:"operator,attr,omitempty"`
+	Prompt           *string       `xml:"prompt,attr"`
+	PromptTitle      *string       `xml:"promptTitle,attr"`
+	ShowDropDown     bool          `xml:"showDropDown,attr,omitempty"`
+	ShowErrorMessage bool          `xml:"showErrorMessage,attr,omitempty"`
+	ShowInputMessage bool          `xml:"showInputMessage,attr,omitempty"`
+	Sqref            string        `xml:"sqref,attr"`
+	Type             string        `xml:"type,attr,omitempty"`
+	Formula1         *xlsxInnerXML `xml:"x14:formula1"`
+	Formula2         *xlsxInnerXML `xml:"x14:formula2"`
+	XMSqref          string        `xml:"xm:sqref,omitempty"`
+}
+
+// xlsxX14DataValidations expresses all data validation information for cells in
+// a sheet extLst element which have data validation features applied.
+type xlsxX14DataValidations struct {
+	XMLName        xml.Name `xml:"x14:dataValidations"`
+	XMLNSXM        string   `xml:"xmlns:xm,attr,omitempty"`
+	Count          int      `xml:"count,attr,omitempty"`
+	DisablePrompts bool     `xml:"disablePrompts,attr,omitempty"`
+	XWindow        int      `xml:"xWindow,attr,omitempty"`
+	YWindow        int      `xml:"yWindow,attr,omitempty"`
+	DataValidation []*xlsxX14DataValidation
+}
+
 // xlsxC collection represents a cell in the worksheet. Information about the
 // cell's location (reference), value, data type, formatting, and formula is
 // expressed here.