#  ATContentTypes http://plone.org/products/atcontenttypes/
#  Archetypes reimplementation of the CMF core types
#  Copyright (c) 2003-2006 AT Content Types development team
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#
#  This program 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 General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program; if not, write to the Free Software
#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
"""
"""

__author__ = 'Alec Mitchell <apm13@columbia.edu>'
__docformat__ = 'restructuredtext'

import os, sys
import transaction
if __name__ == '__main__':
    execfile(os.path.join(sys.path[0], 'framework.py'))

from Testing import ZopeTestCase # side effect import. leave it here.
from Products.ATContentTypes.tests import atcttestcase

from Products.CMFCore.utils import getToolByName
from Products.Archetypes.public import *
from Products.ATContentTypes.tests.utils import dcEdit

from Products.ATContentTypes.content.document import ATDocument
from Products.ATContentTypes.migration.atctmigrator import DocumentMigrator
from Products.CMFDefault.Document import Document

example_stx = """
Header

 Text, Text, Text

   * List
   * List
"""

example_rest = """
Header
======

Text, text, text

* List
* List
"""

def editCMF(obj):
    text_format='stx'
    dcEdit(obj)
    obj.edit(text_format = text_format, text = example_stx)

def editATCT(obj):
    text_format='text/structured'
    dcEdit(obj)
    obj.setText(example_stx, mimetype = text_format)

tests = []

# A manage_afterAdd that auto creates some sibling
def doc_manage_afterAdd(self, item, container, *args, **kwargs):
    self.old_manage_afterAdd(item, container, *args, **kwargs)
    if 'bogus_object' not in container.objectIds():
        container.invokeFactory('Folder', 'bogus_object')

class TestTypeMigrations(atcttestcase.ATCTTypeTestCase):

    klass = ATDocument
    portal_type = 'Document'
    cmf_portal_type = 'CMF Document'
    cmf_klass = Document
    title = 'Page'
    meta_type = 'ATDocument'
    icon = 'document_icon.gif'

    def afterSetUp(self):
        atcttestcase.ATCTTypeTestCase.afterSetUp(self)
        self.old = old =  self._cmf
        self.id  = old.getId()

        self.pm          = self.portal.portal_membership
        self.wf          = self.portal.portal_workflow
        self.portal.acl_users._doAddUser('user1', 'secret', ['Member'], [])
        self.portal.acl_users._doAddUser('user2', 'secret', ['Member'], [])

    def migrateObject(self):
        # edit
        editCMF(self.old)
        self.title       = self.old.Title()
        self.description = self.old.Description()
        self.mod         = self.old.ModificationDate()
        self.created     = self.old.CreationDate()
        self.body        = self.old.CookedBody(stx_level=2)

        # migrated (needs subtransaction to work)
        transaction.savepoint(optimistic=True)
        m = DocumentMigrator(self.old)
        m(unittest=1)
        transaction.savepoint(optimistic=True)

        self.migrated = getattr(self.folder, self.id)

    def test_base_migration(self):
        self.migrateObject()
        self.failUnless(self.id in self.folder.objectIds(), self.folder.objectIds())
        self.compareAfterMigration(self.migrated, mod=self.mod,
                                                created=self.created)
        self.compareDC(self.migrated, title=self.title,
                                        description=self.description)

    def test_role_migration(self):
        self.pm.setLocalRoles( obj=self.old,
                               member_ids=('user1',),
                               member_role='Reviewer')
        self.pm.setLocalRoles( obj=self.old,
                               member_ids=('user2',),
                               member_role='Manager')
        getLR = self.portal.acl_users.getLocalRolesForDisplay
        old_local_roles = getLR(self.old)
        self.migrateObject()

        self.assertEquals(getLR(self.migrated), old_local_roles)

    def test_workflow_migration(self):
        self.wf.doActionFor(self.old, 'hide')
        getWFstate = self.wf.getInfoFor
        old_wf = getWFstate(self.old, 'review_state', None)
        self.login('user1')
        self.login()
        self.migrateObject()

        self.assertEquals(getWFstate(self.migrated, 'review_state', None),
                                old_wf)

    def test_owner_migration(self):
        user = self.portal.acl_users.getUser('user1')
        self.old.changeOwnership(user)
        self.migrateObject()

        self.assertEquals(self.migrated.owner_info()['id'],'user1')

    def test_workflow_permissions(self):
        # permissions are updated after site migration completion
        self.wf.doActionFor(self.old, 'hide')
        getWFstate = self.wf.getInfoFor
        old_wf = getWFstate(self.old, 'review_state', None)
        self.login('user1')
        self.failIf(self.pm.checkPermission('View',self.old))
        self.login()
        transaction.savepoint(optimistic=True)
        self.portal.portal_atct.migrateToATCT(self.portal)
        transaction.savepoint(optimistic=True)

        self.migrated = getattr(self.folder, self.id)

        # check transfer of permissions
        self.login('user1')
        self.failIf(self.pm.checkPermission('View',self.migrated))

    def test_migration_with_missing_FTIs(self):
        # migration shouldn't fail when CMF FTIs are missing
        ttool = getToolByName(self.portal, 'portal_types')
        # Remove Large Plone Folder
        ttool.manage_delObjects(['Large Plone Folder'])

        transaction.savepoint(optimistic=True)
        try:
            self.portal.portal_atct.migrateToATCT()
        except Exception, e:
            import sys, traceback
            self.fail('Failed to migrate types when an expected FTI is missing: %s \n %s'%(e,''.join(traceback.format_tb(sys.exc_traceback))))

    def test_folder_migration_preserves_order(self):
        fold = self._createType(self.folder, 'CMF Folder', 'test_folder')
        doc1 = self._createType(fold, 'CMF Document', 'doc1')
        doc2 = self._createType(fold, 'CMF Document', 'doc2')
        doc3 = self._createType(fold, 'CMF Document', 'doc3')
        doc4 = self._createType(fold, 'CMF Document', 'doc4')
        doc5 = self._createType(fold, 'CMF Document', 'doc5')
        fold.moveObjectToPosition('doc5', 3)
        transaction.savepoint(optimistic=True)
        self.assertEqual(fold.portal_type, 'CMF Folder')
        self.assertEqual(doc1.portal_type, 'CMF Document')
        self.assertEqual(fold.objectIds(),
                                        ['doc1','doc2','doc3','doc5','doc4'])
        self.portal.portal_atct.migrateToATCT()
        fold = self.folder.test_folder
        doc1 = fold.doc1
        self.assertEqual(fold.portal_type, 'Folder')
        self.assertEqual(doc1.portal_type, 'Document')
        self.assertEqual(fold.objectIds(),
                                        ['doc1','doc2','doc3','doc5','doc4'])

    def test_migrationFixCMFPortalTypes(self):
        cat = self.portal.portal_catalog
        cmfdoc = self._createType(self.folder, 'CMF Document', 'cmfdoc')
        self.failUnlessEqual(cmfdoc.portal_type, 'CMF Document')
        # fake the name of an important/copied object
        # it would have the old name
        cmfdoc._setPortalTypeName('Document')
        # recatalog so the catalog knows about the new name
        cat.reindexObject(cmfdoc)
        self.failUnlessEqual(cmfdoc.portal_type, 'Document')

        transaction.savepoint() # subtransaction

        atct = self.portal.portal_atct

        changed, elapse, c_elapse = atct.migrationFixCMFPortalTypes()
        self.failUnlessEqual(changed, '/'.join(cmfdoc.getPhysicalPath()))
        self.failUnlessEqual(cmfdoc.portal_type, 'CMF Document')

    def test_migrate_container_with_autogenerated_objects(self):
        self.setRoles(('Manager','Member'))
        #Monkey patch ATDocument to do funny things in manage_afterAdd
        ATDocument.old_manage_afterAdd = ATDocument.manage_afterAdd.im_func
        ATDocument.manage_afterAdd = doc_manage_afterAdd
        cmffolder = self._createType(self.folder, 'CMF Folder', 'cmffolder')
        # should create document and bogus autogenerated object
        cmffolder.invokeFactory('Document', 'doc')
        self.failUnless('bogus_object' in cmffolder.objectIds())
        transaction.savepoint() # subtransaction
        try:
            self.portal.portal_atct.migrateToATCT()
        except Exception, e:
            ATDocument.manage_afterAdd = ATDocument.old_manage_afterAdd.im_func
            del ATDocument.old_manage_afterAdd
            self.fail('Migration raised error %s'%e)
        self.failUnless('bogus_object' in self.folder.cmffolder.objectIds())
        ATDocument.manage_afterAdd = ATDocument.old_manage_afterAdd.im_func
        del ATDocument.old_manage_afterAdd


tests.append(TestTypeMigrations)

if __name__ == '__main__':
    framework()
else:
    # While framework.py provides its own test_suite()
    # method the testrunner utility does not.
    import unittest
    def test_suite():
        suite = unittest.TestSuite()
        for test in tests:
            suite.addTest(unittest.makeSuite(test))
        return suite
