# -*- coding: utf-8 -*-

# copyright 2003-2014 LOGILAB S.A. (Paris, FRANCE), all rights reserved.

# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr

#

# This file is part of CubicWeb.

#

# CubicWeb is free software: you can redistribute it and/or modify it under the

# terms of the GNU Lesser General Public License as published by the Free

# Software Foundation, either version 2.1 of the License, or (at your option)

# any later version.

#

# CubicWeb is distributed in the hope that it will be useful, but WITHOUT

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more

# details.

#

# You should have received a copy of the GNU Lesser General Public License along

# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.

"""XXX rename, split, reorganize this"""

from logilab.common.testlib import unittest_main

from cubicweb.devtools.testlib import CubicWebTC

from cubicweb import Binary, UnknownProperty

from cubicweb.predicates import (is_instance,

                                 specified_etype_implements, rql_condition)

from cubicweb.web import NoSelectableObject

from cubicweb.web.action import Action

from cubicweb.web.views import (primary, baseviews, tableview,

                                editforms, management, actions, startup, cwuser, schema, xbel,

                                vcard, owl, treeview, idownloadable, wdoc, debug, cwuser,

                                cwproperties, cwsources, xmlrss, rdf, csvexport, json,

                                undohistory)

from cubes.folder import views as folderviews

USERACTIONS = [actions.UserPreferencesAction,

               actions.UserInfoAction,

               actions.LogoutAction]

SITEACTIONS = [actions.ManageAction]

FOOTERACTIONS = [wdoc.HelpAction,

                 wdoc.AboutAction,

                 actions.PoweredByAction]

MANAGEACTIONS = [actions.SiteConfigurationAction,

                 schema.ViewSchemaAction,

                 cwuser.ManageUsersAction,

                 cwsources.ManageSourcesAction,

                 debug.SiteInfoAction]

if hasattr(rdf, 'RDFView'): # not available if rdflib not installed

    RDFVIEWS = [('rdf', rdf.RDFView)]

else:

    RDFVIEWS = []

class ViewSelectorTC(CubicWebTC):

    def setup_database(self):

        with self.admin_access.repo_cnx() as cnx:

            cnx.create_entity('BlogEntry', title=u"une news !", content=u"cubicweb c'est beau")

            cnx.create_entity('Bookmark', title=u"un signet !", path=u"view?vid=index")

            cnx.create_entity('EmailAddress', address=u"devel@logilab.fr", alias=u'devel')

            cnx.create_entity('Tag', name=u'x')

            cnx.commit()

class VRegistryTC(ViewSelectorTC):

    """test the view selector"""

    def _test_registered(self, registry, content):

        try:

            expected = getattr(self, 'all_%s' % registry)

        except AttributeError:

            return

        if registry == 'hooks':

            self.assertEqual(len(content), expected, content)

            return

        try:

            self.assertSetEqual(list(content), expected)

        except Exception:

            print registry, sorted(expected), sorted(content)

            print 'no more', [v for v in expected if not v in content]

            print 'missing', [v for v in content if not v in expected]

            raise

    def setUp(self):

        super(VRegistryTC, self).setUp()

        assert self.vreg['views']['propertiesform']

    def test_possible_views_none_rset(self):

        with self.admin_access.web_request() as req:

            self.assertListEqual(self.pviews(req, None),

                                 [('cw.sources-management', cwsources.CWSourcesManagementView),

                                  ('cw.users-and-groups-management', cwuser.UsersAndGroupsManagementView),

                                  ('gc', debug.GCView),

                                  ('index', startup.IndexView),

                                  ('info', debug.ProcessInformationView),

                                  ('manage', startup.ManageView),

                                  ('owl', owl.OWLView),

                                  ('propertiesform', cwproperties.CWPropertiesForm),

                                  ('registry', debug.RegistryView),

                                  ('schema', schema.SchemaView),

                                  ('siteinfo', debug.SiteInfoView),

                                  ('systempropertiesform', cwproperties.SystemCWPropertiesForm),

                                  ('tree', folderviews.FolderTreeView),

                                  ('undohistory', undohistory.UndoHistoryView)])

    def test_possible_views_noresult(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('Any X WHERE X eid 999999')

            self.assertListEqual(self.pviews(req, rset),

                    [('csvexport', csvexport.CSVRsetView),

                     ('ecsvexport', csvexport.CSVEntityView),

                     ('ejsonexport', json.JsonEntityView),

                     ('jsonexport', json.JsonRsetView),

                     ])

    def test_possible_views_one_egroup(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('CWGroup X WHERE X name "managers"')

            self.assertListEqual(self.pviews(req, rset),

                                 [('csvexport', csvexport.CSVRsetView),

                                  ('ecsvexport', csvexport.CSVEntityView),

                                  ('ejsonexport', json.JsonEntityView),

                                  ('filetree', treeview.FileTreeView),

                                  ('jsonexport', json.JsonRsetView),

                                  ('list', baseviews.ListView),

                                  ('oneline', baseviews.OneLineView),

                                  ('owlabox', owl.OWLABOXView),

                                  ('primary', cwuser.CWGroupPrimaryView)] + \

                                 RDFVIEWS + \

                                 [('rsetxml', xmlrss.XMLRsetView),

                                  ('rss', xmlrss.RSSView),

                                  ('sameetypelist', baseviews.SameETypeListView),

                                  ('security', management.SecurityManagementView),

                                  ('table', tableview.RsetTableView),

                                  ('text', baseviews.TextView),

                                  ('treeview', treeview.TreeView),

                                  ('xbel', xbel.XbelView),

                                  ('xml', xmlrss.XMLView)])

    def test_possible_views_multiple_egroups(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('CWGroup X')

            self.assertListEqual(self.pviews(req, rset),

                                 [('csvexport', csvexport.CSVRsetView),

                                  ('ecsvexport', csvexport.CSVEntityView),

                                  ('ejsonexport', json.JsonEntityView),

                                  ('filetree', treeview.FileTreeView),

                                  ('jsonexport', json.JsonRsetView),

                                  ('list', baseviews.ListView),

                                  ('oneline', baseviews.OneLineView),

                                  ('owlabox', owl.OWLABOXView),

                                  ('primary', cwuser.CWGroupPrimaryView)] + RDFVIEWS + [

                                  ('rsetxml', xmlrss.XMLRsetView),

                                  ('rss', xmlrss.RSSView),

                                  ('sameetypelist', baseviews.SameETypeListView),

                                  ('security', management.SecurityManagementView),

                                  ('table', tableview.RsetTableView),

                                  ('text', baseviews.TextView),

                                  ('treeview', treeview.TreeView),

                                  ('xbel', xbel.XbelView),

                                  ('xml', xmlrss.XMLView),

                                  ])

    def test_propertiesform_admin(self):

        assert self.vreg['views']['propertiesform']

        with self.admin_access.web_request() as req:

            rset1 = req.execute('CWUser X WHERE X login "admin"')

            self.assertTrue(self.vreg['views'].select('propertiesform', req, rset=None))

            self.assertTrue(self.vreg['views'].select('propertiesform', req, rset=rset1))

            rset2 = req.execute('CWUser X WHERE X login "anon"')

            self.assertTrue(self.vreg['views'].select('propertiesform', req, rset=rset2))

    def test_propertiesform_anon(self):

        with self.new_access('anon').web_request() as req:

            rset1 = req.execute('CWUser X WHERE X login "admin"')

            self.assertRaises(NoSelectableObject, self.vreg['views'].select, 'propertiesform', req, rset=None)

            self.assertRaises(NoSelectableObject, self.vreg['views'].select, 'propertiesform', req, rset=rset1)

            rset2 = req.execute('CWUser X WHERE X login "anon"')

            self.assertRaises(NoSelectableObject, self.vreg['views'].select, 'propertiesform', req, rset=rset2)

    def test_propertiesform_jdoe(self):

        with self.admin_access.repo_cnx() as cnx:

            self.create_user(cnx, 'jdoe')

            cnx.commit()

        with self.new_access('jdoe').web_request() as req:

            rset1 = req.execute('CWUser X WHERE X login "admin"')

            rset2 = req.execute('CWUser X WHERE X login "jdoe"')

            self.assertTrue(self.vreg['views'].select('propertiesform', req, rset=None))

            self.assertRaises(NoSelectableObject, self.vreg['views'].select, 'propertiesform', req, rset=rset1)

            self.assertTrue(self.vreg['views'].select('propertiesform', req, rset=rset2))

    def test_possible_views_multiple_different_types(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('Any X')

            self.assertListEqual(self.pviews(req, rset),

                                 [('csvexport', csvexport.CSVRsetView),

                                  ('ecsvexport', csvexport.CSVEntityView),

                                  ('ejsonexport', json.JsonEntityView),

                                  ('filetree', treeview.FileTreeView),

                                  ('jsonexport', json.JsonRsetView),

                                  ('list', baseviews.ListView),

                                  ('oneline', baseviews.OneLineView),

                                  ('owlabox', owl.OWLABOXView),

                                  ('primary', primary.PrimaryView),] + RDFVIEWS + [

                                  ('rsetxml', xmlrss.XMLRsetView),

                                  ('rss', xmlrss.RSSView),

                                  ('security', management.SecurityManagementView),

                                  ('table', tableview.RsetTableView),

                                  ('text', baseviews.TextView),

                                  ('treeview', treeview.TreeView),

                                  ('xbel', xbel.XbelView),

                                  ('xml', xmlrss.XMLView),

                                  ])

    def test_possible_views_any_rset(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('Any N, X WHERE X in_group Y, Y name N')

            self.assertListEqual(self.pviews(req, rset),

                                 [('csvexport', csvexport.CSVRsetView),

                                  ('jsonexport', json.JsonRsetView),

                                  ('rsetxml', xmlrss.XMLRsetView),

                                  ('table', tableview.RsetTableView),

                                  ])

    def test_possible_views_multiple_eusers(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('CWUser X')

            self.assertListEqual(self.pviews(req, rset),

                                 [('csvexport', csvexport.CSVRsetView),

                                  ('ecsvexport', csvexport.CSVEntityView),

                                  ('ejsonexport', json.JsonEntityView),

                                  ('filetree', treeview.FileTreeView),

                                  ('foaf', cwuser.FoafView),

                                  ('jsonexport', json.JsonRsetView),

                                  ('list', baseviews.ListView),

                                  ('oneline', baseviews.OneLineView),

                                  ('owlabox', owl.OWLABOXView),

                                  ('primary', primary.PrimaryView)] + RDFVIEWS + [

                                  ('rsetxml', xmlrss.XMLRsetView),

                                  ('rss', xmlrss.RSSView),

                                  ('sameetypelist', baseviews.SameETypeListView),

                                  ('security', management.SecurityManagementView),

                                  ('table', tableview.RsetTableView),

                                  ('text', baseviews.TextView),

                                  ('treeview', treeview.TreeView),

                                  ('vcard', vcard.VCardCWUserView),

                                  ('xbel', xbel.XbelView),

                                  ('xml', xmlrss.XMLView),

                                  ])

    def test_possible_actions_none_rset(self):

        with self.admin_access.web_request() as req:

            self.assertDictEqual(self.pactionsdict(req, None, skipcategories=()),

                                 {'useractions': USERACTIONS,

                                  'siteactions': SITEACTIONS,

                                  'manage': MANAGEACTIONS,

                                  'footer': FOOTERACTIONS})

    def test_possible_actions_no_entity(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('Any X WHERE X eid 999999')

            self.assertDictEqual(self.pactionsdict(req, rset, skipcategories=()),

                                 {'useractions': USERACTIONS,

                                  'siteactions': SITEACTIONS,

                                  'manage': MANAGEACTIONS,

                                  'footer': FOOTERACTIONS,

                                  })

    def test_possible_actions_same_type_entities(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('CWGroup X')

            self.assertDictEqual(self.pactionsdict(req, rset, skipcategories=()),

                                 {'useractions': USERACTIONS,

                                  'siteactions': SITEACTIONS,

                                  'manage': MANAGEACTIONS,

                                  'footer': FOOTERACTIONS,

                                  'mainactions': [actions.MultipleEditAction],

                                  'moreactions': [actions.DeleteAction,

                                                  actions.AddNewAction]})

    def test_possible_actions_different_types_entities(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('Any X')

            self.assertDictEqual(self.pactionsdict(req, rset, skipcategories=()),

                                 {'useractions': USERACTIONS,

                                  'siteactions': SITEACTIONS,

                                  'manage': MANAGEACTIONS,

                                  'footer': FOOTERACTIONS,

                                  'moreactions': [actions.DeleteAction],

                                  })

    def test_possible_actions_final_entities(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('Any N, X WHERE X in_group Y, Y name N')

            self.assertDictEqual(self.pactionsdict(req, rset, skipcategories=()),

                                 {'useractions': USERACTIONS,

                                  'siteactions': SITEACTIONS,

                                  'manage': MANAGEACTIONS,

                                  'footer': FOOTERACTIONS,

                                  })

    def test_possible_actions_eetype_cwuser_entity(self):

        with self.admin_access.web_request() as req:

            rset = req.execute('CWEType X WHERE X name "CWUser"')

            self.assertDictEqual(self.pactionsdict(req, rset, skipcategories=()),

                                 {'useractions': USERACTIONS,

                                  'siteactions': SITEACTIONS,

                                  'manage': MANAGEACTIONS,

                                  'footer': FOOTERACTIONS,

                                  'mainactions': [actions.ModifyAction,

                                                  actions.ViewSameCWEType],

                                  'moreactions': [actions.ManagePermissionsAction,

                                                  actions.AddRelatedActions,

                                                  actions.DeleteAction,

                                                  actions.CopyAction,

                                                  ],

                                  })

    def test_select_creation_form(self):

        rset = None

        with self.admin_access.web_request() as req:

            # creation form

            req.form['etype'] = 'CWGroup'

            self.assertIsInstance(self.vreg['views'].select('creation', req, rset=rset),

                                  editforms.CreationFormView)

        with self.admin_access.web_request() as req:

            # custom creation form

            class CWUserCreationForm(editforms.CreationFormView):

                __select__ = specified_etype_implements('CWUser')

            self.vreg._loadedmods[__name__] = {}

            self.vreg.register(CWUserCreationForm)

            req.form['etype'] = 'CWUser'

            self.assertIsInstance(self.vreg['views'].select('creation', req, rset=rset),

                                  CWUserCreationForm)

    def test_select_view(self):

        # no entity

        rset = None

        with self.admin_access.web_request() as req:

            self.assertIsInstance(self.vreg['views'].select('index', req, rset=rset),

                                  startup.IndexView)

            self.assertRaises(NoSelectableObject,

                              self.vreg['views'].select, 'primary', req, rset=rset)

            self.assertRaises(NoSelectableObject,

                              self.vreg['views'].select, 'table', req, rset=rset)