Introduce a flag for document actions to prompt user for reconfirmation

Author: js-ojus

access_context.go

@@ -766,7 +766,7 @@ func (_AccessContexts) UserPermissions(id AccessContextID, uid UserID) (map[DocT
 }
 
 q := `
-SELECT acpv.doctype_id, acpv.docaction_id, dam.name
+SELECT acpv.doctype_id, acpv.docaction_id, dam.name, dam.reconfirm
 FROM wf_ac_perms_v acpv
 JOIN wf_docactions_master dam ON dam.id = acpv.docaction_id
 WHERE acpv.ac_id = ?
@@ -782,7 +782,7 @@ func (_AccessContexts) UserPermissions(id AccessContextID, uid UserID) (map[DocT
 for rows.Next() {
 var dtid int64
 var da DocAction
-err = rows.Scan(&dtid, &da.ID, &da.Name)
+err = rows.Scan(&dtid, &da.ID, &da.Name, &da.Reconfirm)
 if err != nil {
 return nil, err
 }
@@ -810,7 +810,7 @@ func (_AccessContexts) UserPermissionsByDocType(id AccessContextID, dtype DocTyp
 }
 
 q := `
-SELECT acpv.docaction_id, dam.name
+SELECT acpv.docaction_id, dam.name, dam.reconfirm
 FROM wf_ac_perms_v acpv
 JOIN wf_docactions_master dam ON dam.id = acpv.docaction_id
 WHERE acpv.ac_id = ?
@@ -826,7 +826,7 @@ func (_AccessContexts) UserPermissionsByDocType(id AccessContextID, dtype DocTyp
 res := []DocAction{}
 for rows.Next() {
 var da DocAction
-err = rows.Scan(&da.ID, &da.Name)
+err = rows.Scan(&da.ID, &da.Name, &da.Reconfirm)
 if err != nil {
 return nil, err
 }
@@ -848,7 +848,7 @@ func (_AccessContexts) GroupPermissions(id AccessContextID, gid GroupID) (map[Do
 }
 
 q := `
-SELECT acpv.doctype_id, acpv.docaction_id, dam.name
+SELECT acpv.doctype_id, acpv.docaction_id, dam.name, dam.reconfirm
 FROM wf_ac_perms_v acpv
 JOIN wf_docactions_master dam ON dam.id = acpv.docaction_id
 WHERE acpv.ac_id = ?
@@ -864,7 +864,7 @@ func (_AccessContexts) GroupPermissions(id AccessContextID, gid GroupID) (map[Do
 for rows.Next() {
 var dtid int64
 var da DocAction
-err = rows.Scan(&dtid, &da.ID, &da.Name)
+err = rows.Scan(&dtid, &da.ID, &da.Name, &da.Reconfirm)
 if err != nil {
 return nil, err
 }
@@ -892,7 +892,7 @@ func (_AccessContexts) GroupPermissionsByDocType(id AccessContextID, dtype DocTy
 }
 
 q := `
-SELECT acpv.docaction_id, dam.name
+SELECT acpv.docaction_id, dam.name, dam.reconfirm
 FROM wf_ac_perms_v acpv
 JOIN wf_docactions_master dam ON dam.id = acpv.docaction_id
 WHERE acpv.ac_id = ?
@@ -908,7 +908,7 @@ func (_AccessContexts) GroupPermissionsByDocType(id AccessContextID, dtype DocTy
 res := []DocAction{}
 for rows.Next() {
 var da DocAction
-err = rows.Scan(&da.ID, &da.Name)
+err = rows.Scan(&da.ID, &da.Name, &da.Reconfirm)
 if err != nil {
 return nil, err
 }

docaction.go

@@ -42,8 +42,9 @@ type DocActionID int64
 //
 // N.B. All document actions must be defined as constant strings.
 type DocAction struct {
-ID DocActionID `json:"ID"` // Unique identifier of this action
-Name string `json:"Name"` // Globally-unique name of this action
+ID DocActionID `json:"ID"` // Unique identifier of this action
+Name string `json:"Name"` // Globally-unique name of this action
+Reconfirm bool `json:"Reconfirm"` // Should the user be prompted for a reconfirmation of this action?
 }
 
 // Unexported type, only for convenience methods.
@@ -54,7 +55,7 @@ type _DocActions struct{}
 var DocActions _DocActions
 
 // New creates and registers a new document action in the system.
-func (_DocActions) New(otx *sql.Tx, name string) (DocActionID, error) {
+func (_DocActions) New(otx *sql.Tx, name string, reconfirm bool) (DocActionID, error) {
 name = strings.TrimSpace(name)
 if name == "" {
 return 0, errors.New("document action cannot be empty")
@@ -71,7 +72,13 @@ func (_DocActions) New(otx *sql.Tx, name string) (DocActionID, error) {
 tx = otx
 }
 
-res, err := tx.Exec("INSERT INTO wf_docactions_master(name) VALUES(?)", name)
+var res sql.Result
+var err error
+if reconfirm {
+res, err = tx.Exec("INSERT INTO wf_docactions_master(name, reconfirm) VALUES(?, ?)", name, 1)
+} else {
+res, err = tx.Exec("INSERT INTO wf_docactions_master(name, reconfirm) VALUES(?, ?)", name, 0)
+}
 if err != nil {
 return 0, err
 }
@@ -106,7 +113,7 @@ func (_DocActions) List(offset, limit int64) ([]*DocAction, error) {
 }
 
 q := `
-SELECT *
+SELECT id, name, reconfirm
 FROM wf_docactions_master
 ORDER BY id
 LIMIT ? OFFSET ?
@@ -120,7 +127,7 @@ func (_DocActions) List(offset, limit int64) ([]*DocAction, error) {
 ary := make([]*DocAction, 0, 10)
 for rows.Next() {
 var elem DocAction
-err = rows.Scan(&elem.ID, &elem.Name)
+err = rows.Scan(&elem.ID, &elem.Name, &elem.Reconfirm)
 if err != nil {
 return nil, err
 }
@@ -140,8 +147,8 @@ func (_DocActions) Get(id DocActionID) (*DocAction, error) {
 }
 
 var elem DocAction
-row := db.QueryRow("SELECT id, name FROM wf_docactions_master WHERE id = ?", id)
-err := row.Scan(&elem.ID, &elem.Name)
+row := db.QueryRow("SELECT id, name, reconfirm FROM wf_docactions_master WHERE id = ?", id)
+err := row.Scan(&elem.ID, &elem.Name, &elem.Reconfirm)
 if err != nil {
 return nil, err
 }
@@ -158,8 +165,8 @@ func (_DocActions) GetByName(name string) (*DocAction, error) {
 }
 
 var elem DocAction
-row := db.QueryRow("SELECT id, name FROM wf_docactions_master WHERE name = ?", name)
-err := row.Scan(&elem.ID, &elem.Name)
+row := db.QueryRow("SELECT id, name, reconfirm FROM wf_docactions_master WHERE name = ?", name)
+err := row.Scan(&elem.ID, &elem.Name, &elem.Reconfirm)
 if err != nil {
 return nil, err
 }

doctype.go

@@ -255,7 +255,7 @@ type TransitionMap struct {
 // document currently in the given state can transition.
 func (_DocTypes) Transitions(dtype DocTypeID, from DocStateID) (map[DocStateID]*TransitionMap, error) {
 q := `
-SELECT dst.from_state_id, dsm1.name, dst.docaction_id, dam.name, dst.to_state_id, dsm2.name
+SELECT dst.from_state_id, dsm1.name, dst.docaction_id, dam.name, dam.reconfirm, dst.to_state_id, dsm2.name
 FROM wf_docstate_transitions dst
 JOIN wf_docstates_master dsm1 ON dsm1.id = dst.from_state_id
 JOIN wf_docstates_master dsm2 ON dsm2.id = dst.to_state_id
@@ -281,7 +281,7 @@ func (_DocTypes) Transitions(dtype DocTypeID, from DocStateID) (map[DocStateID]*
 for rows.Next() {
 var dsfrom DocState
 var t Transition
-err := rows.Scan(&dsfrom.ID, &dsfrom.Name, &t.Upon.ID, &t.Upon.Name, &t.To.ID, &t.To.Name)
+err := rows.Scan(&dsfrom.ID, &dsfrom.Name, &t.Upon.ID, &t.Upon.Name, &t.Upon.Reconfirm, &t.To.ID, &t.To.Name)
 if err != nil {
 return nil, err
 }

flow_test.go

@@ -127,15 +127,15 @@ func TestFlowCreate(t *testing.T) {
 tx := fatal1(db.Begin()).(*sql.Tx)
 defer tx.Rollback()
 
-daID1 = fatal1(DocActions.New(tx, "Initialise")).(DocActionID)
-daID2 = fatal1(DocActions.New(tx, "New")).(DocActionID)
-daID3 = fatal1(DocActions.New(tx, "Get")).(DocActionID)
-daID4 = fatal1(DocActions.New(tx, "Update")).(DocActionID)
-daID5 = fatal1(DocActions.New(tx, "Delete")).(DocActionID)
-daID6 = fatal1(DocActions.New(tx, "Approve")).(DocActionID)
-daID7 = fatal1(DocActions.New(tx, "Reject")).(DocActionID)
-daID8 = fatal1(DocActions.New(tx, "Return")).(DocActionID)
-daID9 = fatal1(DocActions.New(tx, "Discard")).(DocActionID)
+daID1 = fatal1(DocActions.New(tx, "Initialise", false)).(DocActionID)
+daID2 = fatal1(DocActions.New(tx, "New", false)).(DocActionID)
+daID3 = fatal1(DocActions.New(tx, "Get", false)).(DocActionID)
+daID4 = fatal1(DocActions.New(tx, "Update", true)).(DocActionID)
+daID5 = fatal1(DocActions.New(tx, "Delete", true)).(DocActionID)
+daID6 = fatal1(DocActions.New(tx, "Approve", false)).(DocActionID)
+daID7 = fatal1(DocActions.New(tx, "Reject", false)).(DocActionID)
+daID8 = fatal1(DocActions.New(tx, "Return", false)).(DocActionID)
+daID9 = fatal1(DocActions.New(tx, "Discard", true)).(DocActionID)
 
 fatal0(tx.Commit())
 })

role.go

@@ -312,7 +312,7 @@ func (_Roles) Permissions(rid RoleID) (map[string]struct {
 Actions []*DocAction
 }, error) {
 q := `
-SELECT dtm.id, dtm.name, dam.id, dam.name
+SELECT dtm.id, dtm.name, dam.id, dam.name, dam.reconfirm
 FROM wf_doctypes_master dtm
 JOIN wf_role_docactions rdas ON dtm.id = rdas.doctype_id
 JOIN wf_docactions_master dam ON dam.id = rdas.docaction_id
@@ -331,7 +331,7 @@ func (_Roles) Permissions(rid RoleID) (map[string]struct {
 for rows.Next() {
 var dt DocType
 var da DocAction
-err = rows.Scan(&dt.ID, &dt.Name, &da.ID, &da.Name)
+err = rows.Scan(&dt.ID, &dt.Name, &da.ID, &da.Name, &da.Reconfirm)
 if err != nil {
 return nil, err
 }

sql/wf_docactions_master.sql

@@ -5,6 +5,7 @@ DROP TABLE IF EXISTS wf_docactions_master;
 CREATE TABLE wf_docactions_master (
  id INT NOT NULL AUTO_INCREMENT,
  name VARCHAR(100) NOT NULL,
+ reconfirm TINYINT(1) NOT NULL,
  PRIMARY KEY (id),
  UNIQUE (name)
 );