diff --git a/webnotes/__init__.py b/webnotes/__init__.py index 21259f298a..70b966009d 100644 --- a/webnotes/__init__.py +++ b/webnotes/__init__.py @@ -124,6 +124,9 @@ def msgprint(msg, small=0, raise_exception=0, as_table=False): raise raise_exception, msg else: raise ValidationError, msg + +def throw(msg, exc=ValidationError): + msgprint(msg, raise_exception=exc) def create_folder(path): import os diff --git a/webnotes/tests/test_nested_set.py b/webnotes/tests/test_nested_set.py new file mode 100644 index 0000000000..ef9e5611fb --- /dev/null +++ b/webnotes/tests/test_nested_set.py @@ -0,0 +1,160 @@ +import unittest, webnotes + +class TestNSM(unittest.TestCase): + def setUp(self): + webnotes.conn.sql("delete from `tabItem Group`") + self.data = [ + ["t1", None, 1, 20], + ["c0", "t1", 2, 3], + ["c1", "t1", 4, 11], + ["gc1", "c1", 5, 6], + ["gc2", "c1", 7, 8], + ["gc3", "c1", 9, 10], + ["c2", "t1", 12, 17], + ["gc4", "c2", 13, 14], + ["gc5", "c2", 15, 16], + ["c3", "t1", 18, 19] + ] + + for d in self.data: + b = webnotes.bean([{ + "doctype": "Item Group", "item_group_name": d[0], "parent_item_group": d[1], + "__islocal": 1, "is_group": "Yes" + }]) + b.insert() + self.__dict__[d[0]] = b + + + self.reload_all() + + def reload_all(self, data=None): + for d in data or self.data: + self.__dict__[d[0]].load_from_db() + + def test_basic_tree(self, data=None): + for d in data or self.data: + self.assertEquals(self.__dict__[d[0]].doc.lft, d[2]) + self.assertEquals(self.__dict__[d[0]].doc.rgt, d[3]) + + def test_validate_loop_move(self): + self.c1.doc.parent_item_group = 'gc3' + self.assertRaises(webnotes.ValidationError, self.c1.save) + + def test_rebuild_tree(self): + from webnotes.utils.nestedset import rebuild_tree + rebuild_tree("Item Group", "parent_item_group") + self.test_basic_tree(self.data) + + def test_move_group(self): + self.c1.doc.parent_item_group = 'c2' + self.c1.save() + self.reload_all() + + new_tree = [ + ["t1", None, 1, 20], + ["c0", "t1", 2, 3], + ["c2", "t1", 4, 17], + ["gc4", "c2", 5, 6], + ["gc5", "c2", 7, 8], + ["c1", "t1", 9, 16], + ["gc1", "c1", 10, 11], + ["gc2", "c1", 12, 13], + ["gc3", "c1", 14, 15], + ["c3", "t1", 18, 19] + ] + self.test_basic_tree(new_tree) + + # Move back + + self.c1.doc.parent_item_group = 'gc4' + self.c1.save() + self.reload_all() + + new_tree = [ + ["t1", None, 1, 20], + ["c0", "t1", 2, 3], + ["c2", "t1", 4, 17], + ["gc4", "c2", 5, 14], + ["c1", "t1", 6, 13], + ["gc1", "c1", 7, 8], + ["gc2", "c1", 9, 10], + ["gc3", "c1", 11, 12], + ["gc5", "c2", 15, 16], + ["c3", "t1", 18, 19] + ] + self.test_basic_tree(new_tree) + + # Move to root + + # self.c1.doc.parent_item_group = '' + # self.c1.save() + # self.reload_all() + # + # new_tree = [ + # ["t1", None, 1, 12], + # ["c0", "t1", 2, 3], + # ["c2", "t1", 4, 9], + # ["gc4", "c2", 5, 6], + # ["gc5", "c2", 7, 8], + # ["c3", "t1", 10, 11], + # ["c1", "t1", 13, 20], + # ["gc1", "c1", 14, 15], + # ["gc2", "c1", 16, 17], + # ["gc3", "c1", 18, 19], + # ] + # self.test_basic_tree(new_tree) + + # move leaf + self.gc3.doc.parent_item_group = 'c2' + self.gc3.save() + self.reload_all() + + new_tree = [ + ["t1", None, 1, 20], + ["c0", "t1", 2, 3], + ["c2", "t1", 4, 17], + ["gc4", "c2", 5, 12], + ["c1", "t1", 6, 11], + ["gc1", "c1", 7, 8], + ["gc2", "c1", 9, 10], + ["gc5", "c2", 13, 14], + ["gc3", "c2", 15, 16], + ["c3", "t1", 18, 19] + ] + self.test_basic_tree(new_tree) + + # delete leaf + from webnotes.model import delete_doc + delete_doc(self.gc2.doc.doctype, self.gc2.doc.name) + + new_tree = [ + ["t1", None, 1, 18], + ["c0", "t1", 2, 3], + ["c2", "t1", 4, 15], + ["gc4", "c2", 5, 10], + ["c1", "t1", 6, 9], + ["gc1", "c1", 7, 8], + ["gc5", "c2", 11, 12], + ["gc3", "c2", 13, 14], + ["c3", "t1", 16, 17] + ] + + del self.__dict__["gc2"] + self.reload_all(new_tree) + self.test_basic_tree(new_tree) + + #print webnotes.conn.sql("""select name, parent_item_group, lft, rgt from `tabItem Group`""") + + # for testing + # for d in new_tree: + # doc = self.__dict__[d[0]].doc + # print doc.name, doc.lft, doc.rgt + + def tearDown(self): + webnotes.conn.rollback() + +if __name__=="__main__": + import webnotes + webnotes.connect() + + unittest.main() \ No newline at end of file diff --git a/webnotes/utils/nestedset.py b/webnotes/utils/nestedset.py index 66ff9a0413..d781a4e371 100644 --- a/webnotes/utils/nestedset.py +++ b/webnotes/utils/nestedset.py @@ -12,155 +12,11 @@ # ------------------------------------------ from __future__ import unicode_literals -import webnotes, unittest +import webnotes from webnotes import msgprint, _ from webnotes.model.bean import Bean from webnotes.model.doc import Document -class TestNSM(unittest.TestCase): - def setUp(self): - webnotes.conn.sql("delete from `tabItem Group`") - self.data = [ - ["t1", None, 1, 20], - ["c0", "t1", 2, 3], - ["c1", "t1", 4, 11], - ["gc1", "c1", 5, 6], - ["gc2", "c1", 7, 8], - ["gc3", "c1", 9, 10], - ["c2", "t1", 12, 17], - ["gc4", "c2", 13, 14], - ["gc5", "c2", 15, 16], - ["c3", "t1", 18, 19] - ] - - for d in self.data: - self.__dict__[d[0]] = Bean([Document(fielddata = { - "doctype": "Item Group", "item_group_name": d[0], "parent_item_group": d[1], - "__islocal": 1 - })]) - - self.save_all() - self.reload_all() - - def save_all(self): - for d in self.data: - self.__dict__[d[0]].save() - - def reload_all(self, data=None): - for d in data or self.data: - self.__dict__[d[0]].load_from_db() - - def test_basic_tree(self, data=None): - for d in data or self.data: - self.assertEquals(self.__dict__[d[0]].doc.lft, d[2]) - self.assertEquals(self.__dict__[d[0]].doc.rgt, d[3]) - - def test_move_group(self): - self.c1.doc.parent_item_group = 'c2' - self.c1.save() - self.reload_all() - - new_tree = [ - ["t1", None, 1, 20], - ["c0", "t1", 2, 3], - ["c2", "t1", 4, 17], - ["gc4", "c2", 5, 6], - ["gc5", "c2", 7, 8], - ["c1", "t1", 9, 16], - ["gc1", "c1", 10, 11], - ["gc2", "c1", 12, 13], - ["gc3", "c1", 14, 15], - ["c3", "t1", 18, 19] - ] - self.test_basic_tree(new_tree) - - # Move back - - self.c1.doc.parent_item_group = 'gc4' - self.c1.save() - self.reload_all() - - new_tree = [ - ["t1", None, 1, 20], - ["c0", "t1", 2, 3], - ["c2", "t1", 4, 17], - ["gc4", "c2", 5, 14], - ["c1", "t1", 6, 13], - ["gc1", "c1", 7, 8], - ["gc2", "c1", 9, 10], - ["gc3", "c1", 11, 12], - ["gc5", "c2", 15, 16], - ["c3", "t1", 18, 19] - ] - self.test_basic_tree(new_tree) - - # Move to root - - self.c1.doc.parent_item_group = '' - self.c1.save() - self.reload_all() - - new_tree = [ - ["t1", None, 1, 12], - ["c0", "t1", 2, 3], - ["c2", "t1", 4, 9], - ["gc4", "c2", 5, 6], - ["gc5", "c2", 7, 8], - ["c3", "t1", 10, 11], - ["c1", "t1", 13, 20], - ["gc1", "c1", 14, 15], - ["gc2", "c1", 16, 17], - ["gc3", "c1", 18, 19], - ] - self.test_basic_tree(new_tree) - - # move leaf - self.gc3.doc.parent_item_group = 'c2' - self.gc3.save() - self.reload_all() - - new_tree = [ - ["t1", None, 1, 14], - ["c0", "t1", 2, 3], - ["c2", "t1", 4, 11], - ["gc4", "c2", 5, 6], - ["gc5", "c2", 7, 8], - ["gc3", "c1", 9, 10], - ["c3", "t1", 12, 13], - ["c1", "t1", 15, 20], - ["gc1", "c1", 16, 17], - ["gc2", "c1", 18, 19], - ] - self.test_basic_tree(new_tree) - - # delete leaf - from webnotes.model import delete_doc - delete_doc(self.gc2.doc.doctype, self.gc2.doc.name) - - new_tree = [ - ["t1", None, 1, 14], - ["c0", "t1", 2, 3], - ["c2", "t1", 4, 11], - ["gc4", "c2", 5, 6], - ["gc5", "c2", 7, 8], - ["gc3", "c1", 9, 10], - ["c3", "t1", 12, 13], - ["c1", "t1", 15, 18], - ["gc1", "c1", 16, 17], - ] - - del self.__dict__["gc2"] - self.reload_all(new_tree) - self.test_basic_tree(new_tree) - - # for testing - # for d in new_tree: - # doc = self.__dict__[d[0]].doc - # print doc.name, doc.lft, doc.rgt - - def tearDown(self): - webnotes.conn.rollback() - # called in the on_update method def update_nsm(doc_obj): # get fields, data from the DocType @@ -183,19 +39,59 @@ def update_nsm(doc_obj): # has parent changed (?) or parent is None (root) if not d.lft and not d.rgt: - update_add_node(d.doctype, d.name, p or '', pf) + update_add_node(d, p or '', pf) elif op != p: update_move_node(d, pf) # set old parent - webnotes.conn.set(d, opf, p or '') + d.fields[opf] = p + webnotes.conn.set_value(d.doctype, d.name, opf, p or '') # reload d._loadfromdb() + +def update_add_node(doc, parent, parent_field): + """ + insert a new node + """ + from webnotes.utils import now + n = now() + + doctype = doc.doctype + name = doc.name + + # get the last sibling of the parent + if parent: + left, right = webnotes.conn.sql("select lft, rgt from `tab%s` where name=%s" \ + % (doctype, "%s"), parent)[0] + validate_loop(doc.doctype, doc.name, left, right) + else: # root + right = webnotes.conn.sql("select ifnull(max(rgt),0)+1 from `tab%s` where ifnull(`%s`,'') =''" % (doctype, parent_field))[0][0] + right = right or 1 + + # update all on the right + webnotes.conn.sql("update `tab%s` set rgt = rgt+2, modified='%s' where rgt >= %s" %(doctype,n,right)) + webnotes.conn.sql("update `tab%s` set lft = lft+2, modified='%s' where lft >= %s" %(doctype,n,right)) + # update index of new node + if webnotes.conn.sql("select * from `tab%s` where lft=%s or rgt=%s"% (doctype, right, right+1)): + webnotes.msgprint("Nested set error. Please send mail to support") + raise Exception + + webnotes.conn.sql("update `tab%s` set lft=%s, rgt=%s, modified='%s' where name='%s'" % (doctype,right,right+1,n,name)) + return right + + def update_move_node(doc, parent_field): - # move to dark side parent = doc.fields.get(parent_field) + + if parent: + new_parent = webnotes.conn.sql("""select lft, rgt from `tab%s` + where name = %s""" % (doc.doctype, '%s'), parent, as_dict=1)[0] + + validate_loop(doc.doctype, doc.name, new_parent.lft, new_parent.rgt) + + # move to dark side webnotes.conn.sql("""update `tab%s` set lft = -lft, rgt = -rgt where lft >= %s and rgt <= %s"""% (doc.doctype, '%s', '%s'), (doc.lft, doc.rgt)) @@ -213,6 +109,7 @@ def update_move_node(doc, parent_field): new_parent = webnotes.conn.sql("""select lft, rgt from `tab%s` where name = %s""" % (doc.doctype, '%s'), parent, as_dict=1)[0] + # set parent lft, rgt webnotes.conn.sql("""update `tab%s` set rgt = rgt + %s where name = %s"""% (doc.doctype, '%s', '%s'), (diff, parent)) @@ -238,7 +135,6 @@ def update_move_node(doc, parent_field): webnotes.conn.sql("""update `tab%s` set lft = -lft + %s, rgt = -rgt + %s where lft < 0"""% (doc.doctype, '%s', '%s'), (new_diff, new_diff)) - def rebuild_tree(doctype, parent_field): """ call rebuild_node for all root nodes @@ -275,31 +171,12 @@ def rebuild_node(doctype, parent, left, parent_field): #return the right value of this node + 1 return right+1 -def update_add_node(doctype, name, parent, parent_field): - """ - insert a new node - """ - from webnotes.utils import now - n = now() - - # get the last sibling of the parent - if parent: - right = webnotes.conn.sql("select rgt from `tab%s` where name='%s'" % (doctype, parent))[0][0] - else: # root - right = webnotes.conn.sql("select ifnull(max(rgt),0)+1 from `tab%s` where ifnull(`%s`,'') =''" % (doctype, parent_field))[0][0] - right = right or 1 - - # update all on the right - webnotes.conn.sql("update `tab%s` set rgt = rgt+2, modified='%s' where rgt >= %s" %(doctype,n,right)) - webnotes.conn.sql("update `tab%s` set lft = lft+2, modified='%s' where lft >= %s" %(doctype,n,right)) - - # update index of new node - if webnotes.conn.sql("select * from `tab%s` where lft=%s or rgt=%s"% (doctype, right, right+1)): - webnotes.msgprint("Nested set error. Please send mail to support") - raise Exception - webnotes.conn.sql("update `tab%s` set lft=%s, rgt=%s, modified='%s' where name='%s'" % (doctype,right,right+1,n,name)) - return right +def validate_loop(doctype, name, lft, rgt): + """check if item not an ancestor (loop)""" + if name in webnotes.conn.sql_list("""select name from `tab%s` where lft <= %s and rgt >= %s""" % (doctype, + "%s", "%s"), (lft, rgt)): + webnotes.throw("""Item cannot be added to its own descendents.""") class DocTypeNestedSet(object): def on_update(self): @@ -310,7 +187,7 @@ class DocTypeNestedSet(object): if not parent: msgprint(_("Root ") + self.doc.doctype + _(" cannot be deleted."), raise_exception=1) - parent = "" + self.doc.fields[self.nsm_parent_field] = "" update_nsm(self) def on_rename(self, newdn, olddn, merge=False, group_fname="is_group"): @@ -321,4 +198,10 @@ class DocTypeNestedSet(object): Ledger-to-Ledger"""), raise_exception=1) parent_field = "parent_" + self.doc.doctype.replace(" ", "_").lower() - rebuild_tree(self.doc.doctype, parent_field) \ No newline at end of file + rebuild_tree(self.doc.doctype, parent_field) + + def validate_one_root(self): + if not self.doc.fields[self.nsm_parent_field]: + if webnotes.conn.sql("""select count(*) from `tab%s` where + ifnull(%s, '')=''""" % (self.doc.doctype, self.nsm_parent_field))[0][0] > 1: + webnotes.throw(_("""Multiple root nodes not allowed."""))