testDms.py 120 KB
Newer Older
1
# -*- coding: utf-8 -*-
Bartek Górny's avatar
Bartek Górny committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
##############################################################################
#
# Copyright (c) 2004 Nexedi SARL and Contributors. All Rights Reserved.
#          Sebastien Robin <seb@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# 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.
#
##############################################################################

30 31 32
"""
  A test suite for Document Management System functionality.
  This will test:
Bartek Górny's avatar
Bartek Górny committed
33
  - creating Text Document objects
34 35 36 37 38 39 40 41 42 43 44 45 46
  - setting properties of a document, assigning local roles
  - setting relations between documents (explicit and implicity)
  - searching in basic and advanced modes
  - document publication workflow settings
  - sourcing external content
  - (...)
  This will NOT test:
  - contributing files of various types
  - convertion between many formats
  - metadata extraction and editing
  - email ingestion
  These are subject to another suite "testIngestion".
"""
Bartek Górny's avatar
Bartek Górny committed
47

48
import unittest
49
import time
50 51
import StringIO
from cgi import FieldStorage
Bartek Górny's avatar
Bartek Górny committed
52

53
import ZPublisher.HTTPRequest
54
import transaction
Bartek Górny's avatar
Bartek Górny committed
55 56
from Testing import ZopeTestCase
from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
57
from Products.ERP5Type.tests.ERP5TypeTestCase import  _getConversionServerDict
58
from Products.ERP5Type.tests.utils import FileUpload
59
from Products.ERP5Type.tests.utils import DummyLocalizer
60
from Products.ERP5OOo.OOoUtils import OOoBuilder
61
from Products.CMFCore.utils import getToolByName
Jérome Perrin's avatar
Jérome Perrin committed
62
from AccessControl.SecurityManagement import newSecurityManager
63
from AccessControl import getSecurityManager
Bartek Górny's avatar
Bartek Górny committed
64
from zLOG import LOG
65
from Products.ERP5.Document.Document import NotConvertedError
66
from Products.ERP5Form.PreferenceTool import Priority
67
from Products.ERP5Type.tests.utils import createZODBPythonScript
68
from Products.ERP5Type.Globals import get_request
Bartek Górny's avatar
Bartek Górny committed
69
import os
70 71
from threading import Thread
import httplib
72
import urllib
73
import difflib
74
from AccessControl import Unauthorized
75
from Products.ERP5Type import Permissions
Ivan Tyagov's avatar
Ivan Tyagov committed
76
from Products.ERP5Type.tests.backportUnittest import expectedFailure
Bartek Górny's avatar
Bartek Górny committed
77

Bartek Górny's avatar
Bartek Górny committed
78 79
QUIET = 0

80
TEST_FILES_HOME = os.path.join(os.path.dirname(__file__), 'test_document')
Nicolas Delaby's avatar
Nicolas Delaby committed
81
FILENAME_REGULAR_EXPRESSION = "(?P<reference>[A-Z]{3,10})-(?P<language>[a-z]{2})-(?P<version>[0-9]{3})"
82
REFERENCE_REGULAR_EXPRESSION = "(?P<reference>[A-Z]{3,10})(-(?P<language>[a-z]{2}))?(-(?P<version>[0-9]{3}))?"
83

Bartek Górny's avatar
Bartek Górny committed
84
def makeFilePath(name):
85
  return os.path.join(os.path.dirname(__file__), 'test_document', name)
Bartek Górny's avatar
Bartek Górny committed
86

87 88 89 90 91
def makeFileUpload(name, as_name=None):
  if as_name is None:
    as_name = name
  path = makeFilePath(name)
  return FileUpload(path, as_name)
Bartek Górny's avatar
Bartek Górny committed
92

93
class TestDocumentMixin(ERP5TypeTestCase):
Ivan Tyagov's avatar
Ivan Tyagov committed
94
  
Arnaud Fontaine's avatar
Arnaud Fontaine committed
95 96 97 98 99 100 101 102
  business_template_list = ['erp5_core_proxy_field_legacy',
                            'erp5_jquery',
                            'erp5_full_text_myisam_catalog',
                            'erp5_base',
                            'erp5_ingestion_mysql_innodb_catalog', 
                            'erp5_ingestion',
                            'erp5_web', 
                            'erp5_dms']
Ivan Tyagov's avatar
Ivan Tyagov committed
103

104
  def setUpOnce(self):
105 106
    # set a dummy localizer (because normally it is cookie based)
    self.portal.Localizer = DummyLocalizer()
107 108 109 110
    # make sure every body can traverse document module
    self.portal.document_module.manage_permission('View', ['Anonymous'], 1)
    self.portal.document_module.manage_permission(
                           'Access contents information', ['Anonymous'], 1)
111 112
    transaction.commit()
    self.tic()
Bartek Górny's avatar
Bartek Górny committed
113

114
  def afterSetUp(self):
115
    TestDocumentMixin.login(self)
116 117 118 119
    self.setDefaultSitePreference()
    self.setSystemPreference()
    transaction.commit()
    self.tic()
120
    self.login()
121

122 123
  def setDefaultSitePreference(self):
    default_pref = self.portal.portal_preferences.default_site_preference
124 125 126
    conversion_dict = _getConversionServerDict()
    default_pref.setPreferredOoodocServerAddress(conversion_dict['hostname'])
    default_pref.setPreferredOoodocServerPortNumber(conversion_dict['port'])
Nicolas Delaby's avatar
Nicolas Delaby committed
127
    default_pref.setPreferredDocumentFilenameRegularExpression(FILENAME_REGULAR_EXPRESSION)
128
    default_pref.setPreferredDocumentReferenceRegularExpression(REFERENCE_REGULAR_EXPRESSION)
129
    if self.portal.portal_workflow.isTransitionPossible(default_pref, 'enable'):
130
      default_pref.enable()
131
    return default_pref
132

133 134 135 136 137
  def setSystemPreference(self):
    portal_type = 'System Preference'
    preference_list = self.portal.portal_preferences.contentValues(
                                                       portal_type=portal_type)
    if not preference_list:
138
      preference = self.portal.portal_preferences.newContent(title="Default System Preference",
139 140
                                                             # use local RAM based cache as some tests need it
                                                             preferred_conversion_cache_factory = 'erp5_content_long',
141
                                                             portal_type=portal_type)
142 143
    else:
      preference = preference_list[0]
144
    if self.portal.portal_workflow.isTransitionPossible(preference, 'enable'):
145 146 147
      preference.enable()
    return preference

Bartek Górny's avatar
Bartek Górny committed
148 149 150 151
  def getDocumentModule(self):
    return getattr(self.getPortal(),'document_module')

  def getBusinessTemplateList(self):
Arnaud Fontaine's avatar
Arnaud Fontaine committed
152
    return self.business_template_list
Bartek Górny's avatar
Bartek Górny committed
153 154

  def getNeededCategoryList(self):
155
    return ()
Bartek Górny's avatar
Bartek Górny committed
156

157
  def beforeTearDown(self):
158 159 160 161
    """
      Do some stuff after each test:
      - clear document module
    """
162
    transaction.abort()
163
    self.clearRestrictedSecurityHelperScript()
164 165 166 167 168 169 170
    activity_tool = self.portal.portal_activities
    activity_status = set(m.processing_node < -1
                          for m in activity_tool.getMessageList())
    if True in activity_status:
      activity_tool.manageClearActivities()
    else:
      assert not activity_status
171
    self.clearDocumentModule()
172

173 174 175
  conversion_format_permission_script_id_list = [
      'Document_checkConversionFormatPermission',
      'PDF_checkConversionFormatPermission']
176
  def clearRestrictedSecurityHelperScript(self):
177 178 179 180 181
    for script_id in self.conversion_format_permission_script_id_list:
      custom = self.getPortal().portal_skins.custom
      if script_id in custom.objectIds():
        custom.manage_delObjects(ids=[script_id])
        transaction.commit()
182

183
  def clearDocumentModule(self):
Bartek Górny's avatar
Bartek Górny committed
184
    """
185
      Remove everything after each run
Bartek Górny's avatar
Bartek Górny committed
186
    """
187
    transaction.abort()
188
    doc_module = self.getDocumentModule()
189
    doc_module.manage_delObjects(list(doc_module.objectIds()))
190
    transaction.commit()
191 192
    self.tic()

193 194 195 196 197 198 199 200 201 202 203
class TestDocument(TestDocumentMixin):
  """
    Test basic document - related operations
  """

  def getTitle(self):
    return "DMS"

  ## setup

  
204
  ## helper methods
Bartek Górny's avatar
Bartek Górny committed
205

Nicolas Delaby's avatar
Nicolas Delaby committed
206
  def createTestDocument(self, filename=None, portal_type='Text', reference='TEST', version='002', language='en'):
Bartek Górny's avatar
Bartek Górny committed
207 208 209
    """
      Creates a text document
    """
210
    dm=self.getPortal().document_module
211
    doctext=dm.newContent(portal_type=portal_type)
Nicolas Delaby's avatar
Nicolas Delaby committed
212 213
    if filename is not None:
      f = open(makeFilePath(filename), 'rb')
Bartek Górny's avatar
Bartek Górny committed
214 215 216 217 218
      doctext.setTextContent(f.read())
      f.close()
    doctext.setReference(reference)
    doctext.setVersion(version)
    doctext.setLanguage(language)
219
    return doctext
Bartek Górny's avatar
Bartek Górny committed
220

Bartek Górny's avatar
Bartek Górny committed
221 222 223 224 225 226 227 228
  def getDocument(self, id):
    """
      Returns a document with given ID in the
      document module.
    """
    document_module = self.portal.document_module
    return getattr(document_module, id)

229 230 231
  def clearCache(self):
    self.portal.portal_caches.clearAllCache()

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
  def getPreferences(self, image_display):
    preference_tool = self.portal.getPortalObject().portal_preferences
    height_preference = 'preferred_%s_image_height' % (image_display,)
    width_preference = 'preferred_%s_image_width' % (image_display,)
    height = int(preference_tool.getPreference(height_preference))
    width = int(preference_tool.getPreference(width_preference))
    return (width, height)

  def getURLSizeList(self, uri, **kw):
    # __ac=RVJQNVR5cGVUZXN0Q2FzZTo%3D is encoded ERP5TypeTestCase with empty password
    url = '%s?%s&__ac=%s' %(uri, urllib.urlencode(kw), 'RVJQNVR5cGVUZXN0Q2FzZTo%3D')
    format=kw.get('format', 'jpeg')
    infile = urllib.urlopen(url)
    # save as file with proper incl. format filename (for some reasons PIL uses this info)
    filename = "%s%stest-image-format-resize.%s" %(os.getcwd(), os.sep, format)
    f = open(filename, "w")
    image_data = infile.read()
    f.write(image_data)
    f.close()
    infile.close()
    file_size = len(image_data)
    try:
      from PIL import Image
      image = Image.open(filename)
      image_size = image.size
    except ImportError:
      from subprocess import Popen, PIPE
      identify_output = Popen(['identify', filename],
                              stdout=PIPE).communicate()[0]
      image_size = tuple(map(lambda x:int(x),
                             identify_output.split()[2].split('x')))
    os.remove(filename)
    return image_size, file_size

266 267
  ## tests

268
  def test_01_HasEverything(self):
Bartek Górny's avatar
Bartek Górny committed
269 270 271
    """
      Standard test to make sure we have everything we need - all the tools etc
    """
272 273 274 275 276 277
    self.assertNotEqual(self.getCategoryTool(), None)
    self.assertNotEqual(self.getSimulationTool(), None)
    self.assertNotEqual(self.getTypeTool(), None)
    self.assertNotEqual(self.getSQLConnection(), None)
    self.assertNotEqual(self.getCatalogTool(), None)
    self.assertNotEqual(self.getWorkflowTool(), None)
278

279
  def test_02_RevisionSystem(self):
Bartek Górny's avatar
Bartek Górny committed
280 281 282 283
    """
      Test revision mechanism
    """
    # create a test document
284
    # revision should be 1
Bartek Górny's avatar
Bartek Górny committed
285
    # upload file (can be the same) into it
286
    # revision should now be 2
287 288
    # edit the document with any value or no values
    # revision should now be 3
Bartek Górny's avatar
Bartek Górny committed
289
    # contribute the same file through portal_contributions
290 291
    # the same document should now have revision 4 (because it should have done mergeRevision)
    # getRevisionList should return (1, 2, 3, 4)
292 293 294
    filename = 'TEST-en-002.doc'
    file = makeFileUpload(filename)
    document = self.portal.portal_contributions.newContent(file=file)
295
    transaction.commit()
296 297 298 299
    self.tic()
    document_url = document.getRelativeUrl()
    def getTestDocument():
      return self.portal.restrictedTraverse(document_url)
300
    self.assertEqual(getTestDocument().getRevision(), '1')
301
    getTestDocument().edit(file=file)
302
    transaction.commit()
303
    self.tic()
304
    self.assertEqual(getTestDocument().getRevision(), '2')
305
    getTestDocument().edit(title='Hey Joe')
306
    transaction.commit()
307
    self.tic()
308
    self.assertEqual(getTestDocument().getRevision(), '3')
309
    another_document = self.portal.portal_contributions.newContent(file=file)
310
    transaction.commit()
311
    self.tic()
312 313
    self.assertEqual(getTestDocument().getRevision(), '4')
    self.assertEqual(getTestDocument().getRevisionList(), ['1', '2', '3', '4'])
Bartek Górny's avatar
Bartek Górny committed
314

315
  def test_03_Versioning(self):
Bartek Górny's avatar
Bartek Górny committed
316 317 318
    """
      Test versioning
    """
319 320 321 322 323 324 325 326 327 328 329 330 331 332
    # create a document 1, set coordinates (reference=TEST, version=002, language=en)
    # create a document 2, set coordinates (reference=TEST, version=002, language=en)
    # create a document 3, set coordinates (reference=TEST, version=004, language=en)
    # run isVersionUnique on 1, 2, 3 (should return False, False, True)
    # change version of 2 to 003
    # run isVersionUnique on 1, 2, 3  (should return True)
    # run getLatestVersionValue on all (should return 3)
    # run getVersionValueList on 2 (should return [3, 2, 1])
    document_module = self.getDocumentModule()
    docs = {}
    docs[1] = self.createTestDocument(reference='TEST', version='002', language='en')
    docs[2] = self.createTestDocument(reference='TEST', version='002', language='en')
    docs[3] = self.createTestDocument(reference='TEST', version='004', language='en')
    docs[4] = self.createTestDocument(reference='ANOTHER', version='002', language='en')
333
    transaction.commit()
334 335 336 337 338
    self.tic()
    self.failIf(docs[1].isVersionUnique())
    self.failIf(docs[2].isVersionUnique())
    self.failUnless(docs[3].isVersionUnique())
    docs[2].setVersion('003')
339
    transaction.commit()
340 341 342 343 344 345 346 347 348
    self.tic()
    self.failUnless(docs[1].isVersionUnique())
    self.failUnless(docs[2].isVersionUnique())
    self.failUnless(docs[3].isVersionUnique())
    self.failUnless(docs[1].getLatestVersionValue() == docs[3])
    self.failUnless(docs[2].getLatestVersionValue() == docs[3])
    self.failUnless(docs[3].getLatestVersionValue() == docs[3])
    version_list = [br.getRelativeUrl() for br in docs[2].getVersionValueList()]
    self.failUnless(version_list == [docs[3].getRelativeUrl(), docs[2].getRelativeUrl(), docs[1].getRelativeUrl()])
Bartek Górny's avatar
Bartek Górny committed
349

350
  def test_04_VersioningWithLanguage(self):
Bartek Górny's avatar
Bartek Górny committed
351 352 353 354 355 356 357 358 359
    """
      Test versioning with multi-language support
    """
    # create empty test documents, set their coordinates as follows:
    # (1) TEST, 002, en
    # (2) TEST, 002, fr
    # (3) TEST, 002, pl
    # (4) TEST, 003, en
    # (5) TEST, 003, sp
360
    # the following calls (on any doc) should produce the following output:
Bartek Górny's avatar
Bartek Górny committed
361 362 363 364 365 366 367
    # getOriginalLanguage() = 'en'
    # getLanguageList = ('en', 'fr', 'pl', 'sp')
    # getLatestVersionValue() = 4
    # getLatestVersionValue('en') = 4
    # getLatestVersionValue('fr') = 2
    # getLatestVersionValue('pl') = 3
    # getLatestVersionValue('ru') = None
368
    # change user language into 'sp'
Bartek Górny's avatar
Bartek Górny committed
369
    # getLatestVersionValue() = 5
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
    # add documents:
    # (6) TEST, 004, pl
    # (7) TEST, 004, en
    # getLatestVersionValue() = 7
    localizer = self.portal.Localizer
    document_module = self.getDocumentModule()
    docs = {}
    docs[1] = self.createTestDocument(reference='TEST', version='002', language='en')
    time.sleep(1) # time span here because catalog records only full seconds
    docs[2] = self.createTestDocument(reference='TEST', version='002', language='fr')
    time.sleep(1)
    docs[3] = self.createTestDocument(reference='TEST', version='002', language='pl')
    time.sleep(1)
    docs[4] = self.createTestDocument(reference='TEST', version='003', language='en')
    time.sleep(1)
    docs[5] = self.createTestDocument(reference='TEST', version='003', language='sp')
    time.sleep(1)
387
    transaction.commit()
388 389 390 391 392 393 394 395 396 397 398 399 400
    self.tic()
    doc = docs[2] # can be any
    self.failUnless(doc.getOriginalLanguage() == 'en')
    self.failUnless(doc.getLanguageList() == ['en', 'fr', 'pl', 'sp'])
    self.failUnless(doc.getLatestVersionValue() == docs[4]) # there are two latest - it chooses the one in user language
    self.failUnless(doc.getLatestVersionValue('en') == docs[4])
    self.failUnless(doc.getLatestVersionValue('fr') == docs[2])
    self.failUnless(doc.getLatestVersionValue('pl') == docs[3])
    self.failUnless(doc.getLatestVersionValue('ru') == None)
    localizer.changeLanguage('sp') # change user language
    self.failUnless(doc.getLatestVersionValue() == docs[5]) # there are two latest - it chooses the one in user language
    docs[6] = document_module.newContent(reference='TEST', version='004', language='pl')
    docs[7] = document_module.newContent(reference='TEST', version='004', language='en')
401
    transaction.commit()
402 403
    self.tic()
    self.failUnless(doc.getLatestVersionValue() == docs[7]) # there are two latest, neither in user language - it chooses the one in original language
Bartek Górny's avatar
Bartek Górny committed
404

405
  def test_06_testExplicitRelations(self):
Bartek Górny's avatar
Bartek Górny committed
406 407 408 409 410 411 412 413 414 415 416 417
    """
      Test explicit relations.
      Explicit relations are just like any other relation, so no need to test them here
      except for similarity cloud which we test.
    """
    # create test documents:
    # (1) TEST, 002, en
    # (2) TEST, 003, en
    # (3) ONE, 001, en
    # (4) TWO, 001, en
    # (5) THREE, 001, en
    # set 3 similar to 1, 4 to 3, 5 to 4
Romain Courteaud's avatar
Romain Courteaud committed
418
    # getSimilarCloudValueList on 4 should return 1, 3 and 5
Bartek Górny's avatar
Bartek Górny committed
419
    # getSimilarCloudValueList(depth=1) on 4 should return 3 and 5
Fabien Morin's avatar
Fabien Morin committed
420

421 422 423 424 425 426 427 428
    # create documents for test version and language
    # reference, version, language
    kw = {'portal_type': 'Drawing'}
    document1 = self.portal.document_module.newContent(**kw)
    document2 = self.portal.document_module.newContent(**kw)
    document3 = self.portal.document_module.newContent(**kw)
    document4 = self.portal.document_module.newContent(**kw)
    document5 = self.portal.document_module.newContent(**kw)
Fabien Morin's avatar
Fabien Morin committed
429 430

    document6 = self.portal.document_module.newContent(reference='SIX', version='001',
431
                                                                                    language='en',  **kw)
Fabien Morin's avatar
Fabien Morin committed
432
    document7 = self.portal.document_module.newContent(reference='SEVEN', version='001',
433
                                                                                    language='en',  **kw)
Fabien Morin's avatar
Fabien Morin committed
434
    document8 = self.portal.document_module.newContent(reference='SEVEN', version='001',
435
                                                                                    language='fr',  **kw)
Fabien Morin's avatar
Fabien Morin committed
436
    document9 = self.portal.document_module.newContent(reference='EIGHT', version='001',
437
                                                                                    language='en',  **kw)
Fabien Morin's avatar
Fabien Morin committed
438
    document10 = self.portal.document_module.newContent(reference='EIGHT', version='002',
439
                                                                                      language='en',  **kw)
Fabien Morin's avatar
Fabien Morin committed
440
    document11 = self.portal.document_module.newContent(reference='TEN', version='001',
441
                                                                                      language='en',  **kw)
Fabien Morin's avatar
Fabien Morin committed
442
    document12 = self.portal.document_module.newContent(reference='TEN', version='001',
443
                                                                                      language='fr',  **kw)
Fabien Morin's avatar
Fabien Morin committed
444
    document13 = self.portal.document_module.newContent(reference='TEN', version='002',
445
                                                                                      language='en',  **kw)
Romain Courteaud's avatar
Romain Courteaud committed
446 447 448 449

    document3.setSimilarValue(document1)
    document4.setSimilarValue(document3)
    document5.setSimilarValue(document4)
Fabien Morin's avatar
Fabien Morin committed
450

451 452 453
    document6.setSimilarValueList([document8,  document13])
    document7.setSimilarValue([document9])
    document11.setSimilarValue(document7)
Romain Courteaud's avatar
Romain Courteaud committed
454

455
    transaction.commit()
Romain Courteaud's avatar
Romain Courteaud committed
456
    self.tic()
Fabien Morin's avatar
Fabien Morin committed
457

458 459
    #if user language is 'en'
    self.portal.Localizer.changeLanguage('en')
Romain Courteaud's avatar
Romain Courteaud committed
460

461
    # 4 is similar to 3 and 5, 3 similar to 1, last version are the same
Romain Courteaud's avatar
Romain Courteaud committed
462 463 464 465
    self.assertSameSet([document1, document3, document5],
                       document4.getSimilarCloudValueList())
    self.assertSameSet([document3, document5],
                       document4.getSimilarCloudValueList(depth=1))
Bartek Górny's avatar
Bartek Górny committed
466

Fabien Morin's avatar
Fabien Morin committed
467
    self.assertSameSet([document7, document13],
468
                       document6.getSimilarCloudValueList())
Fabien Morin's avatar
Fabien Morin committed
469
    self.assertSameSet([document10, document13],
470
                       document7.getSimilarCloudValueList())
Fabien Morin's avatar
Fabien Morin committed
471
    self.assertSameSet([document7, document13],
472
                       document9.getSimilarCloudValueList())
Fabien Morin's avatar
Fabien Morin committed
473
    self.assertSameSet([],
474 475
                       document10.getSimilarCloudValueList())
    # 11 similar to 7, last version of 7 (en) is 7, similar of 7 is 9, last version of 9 (en) is 10
Fabien Morin's avatar
Fabien Morin committed
476
    self.assertSameSet([document7, document10],
477
                       document11.getSimilarCloudValueList())
Fabien Morin's avatar
Fabien Morin committed
478
    self.assertSameSet([document6, document7],
479 480
                       document13.getSimilarCloudValueList())

481
    transaction.commit()
Fabien Morin's avatar
Fabien Morin committed
482

483 484
    # if user language is 'fr', test that latest documents are prefferable returned in user_language (if available)
    self.portal.Localizer.changeLanguage('fr')
Fabien Morin's avatar
Fabien Morin committed
485 486

    self.assertSameSet([document8, document13],
487
                       document6.getSimilarCloudValueList())
Fabien Morin's avatar
Fabien Morin committed
488
    self.assertSameSet([document6, document13],
489
                       document8.getSimilarCloudValueList())
Fabien Morin's avatar
Fabien Morin committed
490
    self.assertSameSet([document8, document10],
491
                       document11.getSimilarCloudValueList())
Fabien Morin's avatar
Fabien Morin committed
492
    self.assertSameSet([],
493
                       document12.getSimilarCloudValueList())
Fabien Morin's avatar
Fabien Morin committed
494
    self.assertSameSet([document6, document8],
495
                       document13.getSimilarCloudValueList())
Fabien Morin's avatar
Fabien Morin committed
496

497
    transaction.commit()
Fabien Morin's avatar
Fabien Morin committed
498

499 500
    # if user language is "bg"
    self.portal.Localizer.changeLanguage('bg')
Fabien Morin's avatar
Fabien Morin committed
501
    self.assertSameSet([document8, document13],
502 503
                       document6.getSimilarCloudValueList())

504
  def test_07_testImplicitRelations(self):
Bartek Górny's avatar
Bartek Górny committed
505 506 507 508
    """
      Test implicit (wiki-like) relations.
    """
    # XXX this test should be extended to check more elaborate language selection
509 510 511 512

    def sqlresult_to_document_list(result):
      return [i.getObject() for i in result]

Bartek Górny's avatar
Bartek Górny committed
513 514
    # create docs to be referenced:
    # (1) TEST, 002, en
515 516 517 518
    filename = 'TEST-en-002.odt'
    file = makeFileUpload(filename)
    document1 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
519
    # (2) TEST, 002, fr
520 521
    as_name = 'TEST-fr-002.odt'
    file = makeFileUpload(filename, as_name)
522 523
    document2 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
524
    # (3) TEST, 003, en
525 526
    as_name = 'TEST-en-003.odt'
    file = makeFileUpload(filename, as_name)
527 528
    document3 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
529 530
    # create docs to contain references in text_content:
    # REF, 001, en; "I use reference to look up TEST"
531 532 533 534
    filename = 'REF-en-001.odt'
    file = makeFileUpload(filename)
    document4 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
535
    # REF, 002, en; "I use reference to look up TEST"
536 537 538 539
    filename = 'REF-en-002.odt'
    file = makeFileUpload(filename)
    document5 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
540
    # REFLANG, 001, en: "I use reference and language to look up TEST-fr"
541 542 543 544
    filename = 'REFLANG-en-001.odt'
    file = makeFileUpload(filename)
    document6 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
545
    # REFVER, 001, en: "I use reference and version to look up TEST-002"
546 547 548 549
    filename = 'REFVER-en-001.odt'
    file = makeFileUpload(filename)
    document7 = self.portal.portal_contributions.newContent(file=file)

Bartek Górny's avatar
Bartek Górny committed
550
    # REFVERLANG, 001, en: "I use reference, version and language to look up TEST-002-en"
551 552 553 554
    filename = 'REFVERLANG-en-001.odt'
    file = makeFileUpload(filename)
    document8 = self.portal.portal_contributions.newContent(file=file)

555
    transaction.commit()
556
    self.tic()
557 558
    # the implicit predecessor will find documents by reference.
    # version and language are not used.
Bartek Górny's avatar
Bartek Górny committed
559
    # the implicit predecessors should be:
560 561 562 563 564 565 566 567 568

    # for (1): REF-002, REFLANG, REFVER, REFVERLANG
    # document1's reference is TEST. getImplicitPredecessorValueList will
    # return latest version of documents which contains string "TEST".
    self.assertSameSet(
      [document5, document6, document7, document8],
      sqlresult_to_document_list(document1.getImplicitPredecessorValueList()))

    # clear transactional variable cache
569
    transaction.commit()
570 571 572 573 574 575 576 577 578 579 580 581

    # the implicit successors should be return document with appropriate
    # language.

    # if user language is 'en'.
    self.portal.Localizer.changeLanguage('en')

    self.assertSameSet(
      [document3],
      sqlresult_to_document_list(document5.getImplicitSuccessorValueList()))

    # clear transactional variable cache
582
    transaction.commit()
583 584 585 586 587 588 589 590

    # if user language is 'fr'.
    self.portal.Localizer.changeLanguage('fr')
    self.assertSameSet(
      [document2],
      sqlresult_to_document_list(document5.getImplicitSuccessorValueList()))

    # clear transactional variable cache
591
    transaction.commit()
592 593 594 595 596 597

    # if user language is 'ja'.
    self.portal.Localizer.changeLanguage('ja')
    self.assertSameSet(
      [document3],
      sqlresult_to_document_list(document5.getImplicitSuccessorValueList()))
Bartek Górny's avatar
Bartek Górny committed
598

599 600 601 602 603 604 605 606 607 608 609
  def testOOoDocument_get_size(self):
    # test get_size on OOoDocument
    doc = self.portal.document_module.newContent(portal_type='Spreadsheet')
    doc.edit(file=makeFileUpload('import_data_list.ods'))
    self.assertEquals(len(makeFileUpload('import_data_list.ods').read()),
                      doc.get_size())

  def testTempOOoDocument_get_size(self):
    # test get_size on temporary OOoDocument
    from Products.ERP5Type.Document import newTempOOoDocument
    doc = newTempOOoDocument(self.portal, 'tmp')
610
    doc.edit(data='OOo')
611 612
    self.assertEquals(len('OOo'), doc.get_size())

613 614 615 616 617 618 619 620 621 622 623 624 625 626
  def testOOoDocument_hasData(self):
    # test hasData on OOoDocument
    doc = self.portal.document_module.newContent(portal_type='Spreadsheet')
    self.failIf(doc.hasData())
    doc.edit(file=makeFileUpload('import_data_list.ods'))
    self.failUnless(doc.hasData())

  def testTempOOoDocument_hasData(self):
    # test hasData on TempOOoDocument
    from Products.ERP5Type.Document import newTempOOoDocument
    doc = newTempOOoDocument(self.portal, 'tmp')
    self.failIf(doc.hasData())
    doc.edit(file=makeFileUpload('import_data_list.ods'))
    self.failUnless(doc.hasData())
627

628 629 630 631
  def test_Owner_Base_download(self):
    # tests that owners can download OOo documents, and all headers (including
    # filenames) are set correctly
    doc = self.portal.document_module.newContent(
Nicolas Delaby's avatar
Nicolas Delaby committed
632
                                  filename='test.ods',
633 634 635 636 637 638 639 640 641 642 643
                                  portal_type='Spreadsheet')
    doc.edit(file=makeFileUpload('import_data_list.ods'))

    uf = self.portal.acl_users
    uf._doAddUser('member_user1', 'secret', ['Member', 'Owner'], [])
    user = uf.getUserById('member_user1').__of__(uf)
    newSecurityManager(None, user)

    response = self.publish('%s/Base_download' % doc.getPath(),
                            basic='member_user1:secret')
    self.assertEquals(makeFileUpload('import_data_list.ods').read(),
Nicolas Delaby's avatar
Nicolas Delaby committed
644
                      response.getBody())
645 646
    self.assertEquals('application/vnd.oasis.opendocument.spreadsheet',
                      response.headers['content-type'])
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
647
    self.assertEquals('attachment; filename="import_data_list.ods"',
648
                      response.headers['content-disposition'])
649
    self.tic()
650 651 652 653 654

  def test_Member_download_pdf_format(self):
    # tests that members can download OOo documents in pdf format (at least in
    # published state), and all headers (including filenames) are set correctly
    doc = self.portal.document_module.newContent(
Nicolas Delaby's avatar
Nicolas Delaby committed
655
                                  filename='test.ods',
656
                                  portal_type='Spreadsheet')
657
    doc.edit(file=makeFileUpload('import.file.with.dot.in.filename.ods'))
658
    doc.publish()
659
    transaction.commit()
660
    self.tic()
661
    transaction.commit()
662 663 664 665 666 667

    uf = self.portal.acl_users
    uf._doAddUser('member_user2', 'secret', ['Member'], [])
    user = uf.getUserById('member_user2').__of__(uf)
    newSecurityManager(None, user)

668
    response = self.publish('%s?format=pdf' % doc.getPath(),
669
                            basic='member_user2:secret')
Nicolas Delaby's avatar
Nicolas Delaby committed
670
    self.assertEquals('application/pdf', response.getHeader('content-type'))
671
    self.assertEquals('attachment; filename="import.file.with.dot.in.filename.pdf"',
Nicolas Delaby's avatar
Nicolas Delaby committed
672
                      response.getHeader('content-disposition'))
673 674 675 676 677 678 679
    response_body = response.getBody()
    conversion = str(doc.convert('pdf')[1])
    diff = '\n'+'\n'.join(difflib.unified_diff(response_body.splitlines(),
                                          conversion.splitlines(),
                                          fromfile='first_call.pdf',
                                          tofile='second_call.pdf'))
    self.assertEquals(response_body, conversion, diff)
680

681 682 683 684
    # test Print icon works on OOoDocument
    response = self.publish('%s/OOoDocument_print' % doc.getPath())
    self.assertEquals('application/pdf',
                      response.headers['content-type'])
685
    self.assertEquals('attachment; filename="import.file.with.dot.in.filename.pdf"',
686 687
                      response.headers['content-disposition'])

688
  def test_05_getCreationDate(self):
689
    """
Ivan Tyagov's avatar
Ivan Tyagov committed
690
    Check getCreationDate on all document types.
691 692 693 694 695 696 697 698 699 700
    """
    portal = self.getPortalObject()
    for document_type in portal.getPortalDocumentTypeList():
      module = portal.getDefaultModule(document_type)
      obj = module.newContent(portal_type=document_type)
      self.assertNotEquals(obj.getCreationDate(),
                           module.getCreationDate())
      self.assertNotEquals(obj.getCreationDate(),
                           portal.CreationDate())

701
  def test_06_ProcessingStateOfAClonedDocument(self):
702 703 704 705 706 707 708 709 710
    """
    Check that the processing state of a cloned document
    is not draft
    """
    filename = 'TEST-en-002.doc'
    file = makeFileUpload(filename)
    document = self.portal.portal_contributions.newContent(file=file)

    self.assertEquals('converting', document.getExternalProcessingState())
711
    transaction.commit()
712
    self.assertEquals('converting', document.getExternalProcessingState())
713 714 715 716 717 718 719 720

    # Clone a uploaded document
    container = document.getParentValue()
    clipboard = container.manage_copyObjects(ids=[document.getId()])
    paste_result = container.manage_pasteObjects(cb_copy_data=clipboard)
    new_document = container[paste_result[0]['new_id']]

    self.assertEquals('converting', new_document.getExternalProcessingState())
721
    transaction.commit()
722 723 724
    self.assertEquals('converting', new_document.getExternalProcessingState())

    # Change workflow state to converted
725 726
    self.tic()
    self.assertEquals('converted', document.getExternalProcessingState())
727
    self.assertEquals('converted', new_document.getExternalProcessingState())
728

729
    # Clone a converted document
730 731 732 733 734
    container = document.getParentValue()
    clipboard = container.manage_copyObjects(ids=[document.getId()])
    paste_result = container.manage_pasteObjects(cb_copy_data=clipboard)
    new_document = container[paste_result[0]['new_id']]

735
    self.assertEquals('converted', new_document.getExternalProcessingState())
736
    transaction.commit()
737
    self.assertEquals('converted', new_document.getExternalProcessingState())
738 739 740
    self.tic()
    self.assertEquals('converted', new_document.getExternalProcessingState())

741
  def test_07_EmbeddedDocumentOfAClonedDocument(self):
742 743 744 745
    """
    Check the validation state of embedded document when its container is
    cloned
    """
746
    document = self.portal.person_module.newContent(portal_type='Person')
747

748
    sub_document = document.newContent(portal_type='Embedded File')
749
    self.assertEquals('embedded', sub_document.getValidationState())
750
    transaction.commit()
751 752 753 754 755 756 757 758 759 760
    self.tic()
    self.assertEquals('embedded', sub_document.getValidationState())

    # Clone document
    container = document.getParentValue()
    clipboard = container.manage_copyObjects(ids=[document.getId()])

    paste_result = container.manage_pasteObjects(cb_copy_data=clipboard)
    new_document = container[paste_result[0]['new_id']]

761
    new_sub_document_list = new_document.contentValues(portal_type='Embedded File')
762 763 764
    self.assertEquals(1, len(new_sub_document_list))
    new_sub_document = new_sub_document_list[0]
    self.assertEquals('embedded', new_sub_document.getValidationState())
765
    transaction.commit()
766 767 768
    self.tic()
    self.assertEquals('embedded', new_sub_document.getValidationState())

769 770 771
  def test_08_NoImagesCreatedDuringHTMLConversion(self):
    """Converting an ODT to html no longer creates Images embedded in the
    document.
772 773 774 775 776
    """
    filename = 'EmbeddedImage-en-002.odt'
    file = makeFileUpload(filename)
    document = self.portal.portal_contributions.newContent(file=file)

777
    transaction.commit()
778 779 780 781 782
    self.tic()

    self.assertEquals(0, len(document.contentValues(portal_type='Image')))
    document.convert(format='html')
    image_list = document.contentValues(portal_type='Image')
783
    self.assertEquals(0, len(image_list))
784

785
  def test_09_SearchableText(self):
786
    """
787
    Check DMS SearchableText capabilities.
788
    """
Ivan Tyagov's avatar
Ivan Tyagov committed
789
    portal = self.portal
790

791
    # Create a document.
Ivan Tyagov's avatar
Ivan Tyagov committed
792 793 794 795 796 797 798 799 800 801
    document_1 = self.portal.document_module.newContent(
                        portal_type = 'File',
                        description = 'Hello. ScriptableKey is very useful if you want to make your own search syntax.',
                        language = 'en',
                        version = '001')
    document_2 = self.portal.document_module.newContent(
                        portal_type='File',
                        description = 'This test make sure that scriptable key feature on ZSQLCatalog works.',
                        language='fr',
                        version = '002')
Ivan Tyagov's avatar
Ivan Tyagov committed
802 803 804 805 806 807
    document_3 = portal.document_module.newContent(
                   portal_type = 'Presentation',
                   title = "Complete set of tested reports with a long title.",
                   version = '003',
                   language = 'bg',
                   reference = 'tio-test-doc-3')
Ivan Tyagov's avatar
Ivan Tyagov committed
808 809 810 811 812
    person = portal.person_module.newContent(portal_type = 'Person', \
                                             reference= "john",
                                             title='John Doe Great')
    web_page = portal.web_page_module.newContent(portal_type = 'Web Page',
                                                 reference = "page_great_site",
Ivan Tyagov's avatar
Ivan Tyagov committed
813 814 815
                                                 text_content = 'Great website',
                                                 language='en',
                                                 version = '003')
Ivan Tyagov's avatar
Ivan Tyagov committed
816 817 818 819 820
    organisation = portal.organisation_module.newContent( \
                            portal_type = 'Organisation', \
                            reference = 'organisation-1',
                            title='Super nova organisation')
    self.stepTic()
Nicolas Delaby's avatar
Nicolas Delaby committed
821

822
    def getAdvancedSearchTextResultList(searchable_text, portal_type=None,src__=0):
823
      kw = {'full_text': searchable_text}
824 825
      if portal_type is not None:
        kw['portal_type'] = portal_type
826 827
      if src__==1:
        print portal.portal_catalog(src__=src__,**kw)
Ivan Tyagov's avatar
Ivan Tyagov committed
828
      return [x.getObject() for x in portal.portal_catalog(**kw)]
Nicolas Delaby's avatar
Nicolas Delaby committed
829

Ivan Tyagov's avatar
Ivan Tyagov committed
830 831 832 833 834
    # full text search
    self.assertSameSet([document_1], \
      getAdvancedSearchTextResultList('ScriptableKey'))
    self.assertEqual(len(getAdvancedSearchTextResultList('RelatedKey')), 0)
    self.assertSameSet([document_1, document_2], \
Ivan Tyagov's avatar
Ivan Tyagov committed
835
      getAdvancedSearchTextResultList('make', ('File',)))
Ivan Tyagov's avatar
Ivan Tyagov committed
836
    self.assertSameSet([web_page, person], \
837
      getAdvancedSearchTextResultList("Great", ('Person', 'Web Page')))
Ivan Tyagov's avatar
Ivan Tyagov committed
838 839
    # full text search with whole title of a document
    self.assertSameSet([document_3], \
840
      getAdvancedSearchTextResultList(document_3.getTitle(), ('Presentation',)))
Ivan Tyagov's avatar
Ivan Tyagov committed
841 842 843
    # full text search with reference part of searchable_text 
    # (i.e. not specified with 'reference:' - simply part of search text)
    self.assertSameSet([document_3], \
844
      getAdvancedSearchTextResultList(document_3.getReference(), ('Presentation',)))
Ivan Tyagov's avatar
Ivan Tyagov committed
845 846 847 848 849 850 851 852 853

   # full text search with reference
    self.assertSameSet([web_page], \
      getAdvancedSearchTextResultList("reference:%s Great" %web_page.getReference()))
    self.assertSameSet([person],
          getAdvancedSearchTextResultList('reference:%s' %person.getReference()))

    # full text search with portal_type
    self.assertSameSet([person], \
Ivan Tyagov's avatar
Ivan Tyagov committed
854 855
      getAdvancedSearchTextResultList('%s portal_type:%s' %(person.getTitle(), person.getPortalType())))

Ivan Tyagov's avatar
Ivan Tyagov committed
856
    self.assertSameSet([organisation], \
Ivan Tyagov's avatar
Ivan Tyagov committed
857 858 859
      getAdvancedSearchTextResultList('%s portal_type:%s' \
                                       %(organisation.getTitle(),
                                         organisation.getPortalType())))
860 861 862

    # full text search with portal_type passed outside searchable_text
    self.assertSameSet([web_page, person],
863 864
                       getAdvancedSearchTextResultList('Great',
                          ('Person', 'Web Page')))
865 866 867 868 869
    self.assertSameSet([web_page], \
                       getAdvancedSearchTextResultList('Great', web_page.getPortalType()))
    self.assertSameSet([person], \
                       getAdvancedSearchTextResultList('Great', person.getPortalType()))
    
Ivan Tyagov's avatar
Ivan Tyagov committed
870 871
    # full text search with portal_type & reference
    self.assertSameSet([person], \
Ivan Tyagov's avatar
Ivan Tyagov committed
872 873 874 875 876 877
      getAdvancedSearchTextResultList('reference:%s portal_type:%s' \
                                        %(person.getReference(), person.getPortalType())))
    # full text search with language
    self.assertSameSet([document_1, web_page], \
      getAdvancedSearchTextResultList('language:en'))
    self.assertSameSet([document_1], \
878
      getAdvancedSearchTextResultList('ScriptableKey language:en'))
Ivan Tyagov's avatar
Ivan Tyagov committed
879 880 881 882 883 884 885 886 887 888 889 890 891 892
    self.assertSameSet([document_2], \
      getAdvancedSearchTextResultList('language:fr'))
    self.assertSameSet([web_page], \
      getAdvancedSearchTextResultList('%s reference:%s language:%s' \
                                       %(web_page.getTextContent(),
                                         web_page.getReference(),
                                         web_page.getLanguage())))
    # full text search with version
    self.assertSameSet([web_page], \
      getAdvancedSearchTextResultList('%s reference:%s language:%s version:%s' \
                                       %(web_page.getTextContent(),
                                         web_page.getReference(),
                                         web_page.getLanguage(),
                                         web_page.getVersion())))
893
  def test_10_SearchString(self):
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
    """
    Test search string search generation and parsing.
    """

    portal = self.portal
    assemble = portal.Base_assembleSearchString
    parse = portal.Base_parseSearchString
    
    # directly pasing searchable string
    self.assertEquals('searchable text',
                      assemble(**{'searchabletext': 'searchable text'}))
    kw = {'searchabletext_any': 'searchabletext_any',
          'searchabletext_phrase': 'searchabletext_phrase1 searchabletext_phrase1'}
    # exact phrase
    search_string = assemble(**kw)
    self.assertEquals('%s "%s"' %(kw['searchabletext_any'], kw['searchabletext_phrase']), \
                      search_string)
    parsed_string = parse(search_string)
    self.assertEquals(['searchabletext'], parsed_string.keys())

    
    # search "with all of the words"
    kw["searchabletext_all"] = "searchabletext_all1 searchabletext_all2"
    search_string = assemble(**kw)
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2', \
                      search_string)
    parsed_string = parse(search_string)
    self.assertEquals(['searchabletext'], parsed_string.keys())
    
    # search without these words 
    kw["searchabletext_without"] = "searchabletext_without1 searchabletext_without2"
    search_string = assemble(**kw)
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2 -searchabletext_without1 -searchabletext_without2', \
                      search_string)
    parsed_string = parse(search_string)
    self.assertEquals(['searchabletext'], parsed_string.keys())
    
    # search limited to a certain date range
    kw['created_within'] = '1w'
    search_string = assemble(**kw)
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2 -searchabletext_without1 -searchabletext_without2 created:1w', \
                      search_string)
    parsed_string = parse(search_string)
    self.assertSameSet(['searchabletext', 'creation_from'], parsed_string.keys())
    
    # search with portal_type
    kw['search_portal_type'] = 'Document'
    search_string = assemble(**kw)
    parsed_string = parse(search_string)
943
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2 -searchabletext_without1 -searchabletext_without2 created:1w AND (portal_type:Document)', \
944 945 946 947 948 949 950 951 952
                      search_string)
    self.assertSameSet(['searchabletext', 'creation_from', 'portal_type'], \
                        parsed_string.keys())
    self.assertEquals(kw['search_portal_type'], parsed_string['portal_type'])
    
    # search by reference
    kw['reference'] = 'Nxd-test'
    search_string = assemble(**kw)
    parsed_string = parse(search_string)
953
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2 -searchabletext_without1 -searchabletext_without2 created:1w AND (portal_type:Document) reference:Nxd-test', \
954 955 956 957 958 959 960 961 962 963
                      search_string)
    self.assertSameSet(['searchabletext', 'creation_from', 'portal_type', 'reference'], \
                        parsed_string.keys())
    self.assertEquals(kw['search_portal_type'], parsed_string['portal_type'])
    self.assertEquals(kw['reference'], parsed_string['reference'])
    
    # search by version
    kw['version'] = '001'
    search_string = assemble(**kw)
    parsed_string = parse(search_string)
964
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2 -searchabletext_without1 -searchabletext_without2 created:1w AND (portal_type:Document) reference:Nxd-test version:001', \
965 966 967 968 969 970 971 972 973 974 975
                      search_string)
    self.assertSameSet(['searchabletext', 'creation_from', 'portal_type', 'reference', 'version'], \
                        parsed_string.keys())
    self.assertEquals(kw['search_portal_type'], parsed_string['portal_type'])
    self.assertEquals(kw['reference'], parsed_string['reference'])
    self.assertEquals(kw['version'], parsed_string['version'])
    
    # search by language
    kw['language'] = 'en'
    search_string = assemble(**kw)
    parsed_string = parse(search_string)
976
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2 -searchabletext_without1 -searchabletext_without2 created:1w AND (portal_type:Document) reference:Nxd-test version:001 language:en', \
977 978 979 980 981 982 983 984 985 986 987 988 989
                      search_string)
    self.assertSameSet(['searchabletext', 'creation_from', 'portal_type', 'reference', \
                        'version', 'language'], \
                        parsed_string.keys())
    self.assertEquals(kw['search_portal_type'], parsed_string['portal_type'])
    self.assertEquals(kw['reference'], parsed_string['reference'])
    self.assertEquals(kw['version'], parsed_string['version'])
    self.assertEquals(kw['language'], parsed_string['language'])
    
    # contributor title search
    kw['contributor_title'] = 'John'
    search_string = assemble(**kw)
    parsed_string = parse(search_string)
990
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2 -searchabletext_without1 -searchabletext_without2 created:1w AND (portal_type:Document) reference:Nxd-test version:001 language:en contributor_title:John', \
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
                      search_string)
    self.assertSameSet(['searchabletext', 'creation_from', 'portal_type', 'reference', \
                        'version', 'language', 'contributor_title'], \
                        parsed_string.keys())
    self.assertEquals(kw['search_portal_type'], parsed_string['portal_type'])
    self.assertEquals(kw['reference'], parsed_string['reference'])
    self.assertEquals(kw['version'], parsed_string['version'])
    self.assertEquals(kw['language'], parsed_string['language'])
    
    # only my docs
    kw['mine'] = 'yes'
    search_string = assemble(**kw)
    parsed_string = parse(search_string)
1004
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2 -searchabletext_without1 -searchabletext_without2 created:1w AND (portal_type:Document) reference:Nxd-test version:001 language:en contributor_title:John mine:yes', \
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
                      search_string)
    self.assertSameSet(['searchabletext', 'creation_from', 'portal_type', 'reference', \
                        'version', 'language', 'contributor_title', 'mine'], \
                        parsed_string.keys())
    self.assertEquals(kw['search_portal_type'], parsed_string['portal_type'])
    self.assertEquals(kw['reference'], parsed_string['reference'])
    self.assertEquals(kw['version'], parsed_string['version'])
    self.assertEquals(kw['language'], parsed_string['language'])
    self.assertEquals(kw['mine'], parsed_string['mine'])
    
    # only newest versions 
    kw['newest'] = 'yes'
    search_string = assemble(**kw)
    parsed_string = parse(search_string)
1019
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2 -searchabletext_without1 -searchabletext_without2 created:1w AND (portal_type:Document) reference:Nxd-test version:001 language:en contributor_title:John mine:yes newest:yes', \
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
                      search_string)
    self.assertSameSet(['searchabletext', 'creation_from', 'portal_type', 'reference', \
                        'version', 'language', 'contributor_title', 'mine', 'newest'], \
                        parsed_string.keys())
    self.assertEquals(kw['search_portal_type'], parsed_string['portal_type'])
    self.assertEquals(kw['reference'], parsed_string['reference'])
    self.assertEquals(kw['version'], parsed_string['version'])
    self.assertEquals(kw['language'], parsed_string['language'])
    self.assertEquals(kw['mine'], parsed_string['mine'])
    self.assertEquals(kw['newest'], parsed_string['newest'])
    
    # search mode 
    kw['search_mode'] = 'in_boolean_mode'
    search_string = assemble(**kw)
    parsed_string = parse(search_string)
1035
    self.assertEquals('searchabletext_any "searchabletext_phrase1 searchabletext_phrase1"  +searchabletext_all1 +searchabletext_all2 -searchabletext_without1 -searchabletext_without2 created:1w AND (portal_type:Document) reference:Nxd-test version:001 language:en contributor_title:John mine:yes newest:yes mode:boolean', \
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
                      search_string)
    self.assertSameSet(['searchabletext', 'creation_from', 'portal_type', 'reference', \
                        'version', 'language', 'contributor_title', 'mine', 'newest', 'mode'], \
                        parsed_string.keys())
    self.assertEquals(kw['search_portal_type'], parsed_string['portal_type'])
    self.assertEquals(kw['reference'], parsed_string['reference'])
    self.assertEquals(kw['version'], parsed_string['version'])
    self.assertEquals(kw['language'], parsed_string['language'])
    self.assertEquals(kw['mine'], parsed_string['mine'])
    self.assertEquals(kw['newest'], parsed_string['newest'])
    self.assertEquals('boolean', parsed_string['mode'])
1047

1048
    # search with multiple portal_type
1049
    kw = {'search_portal_type': ['Document','Presentation','Web Page'],
1050 1051 1052
           'searchabletext_any': 'erp5'}
    search_string = assemble(**kw)
    parsed_string = parse(search_string)
1053
    self.assertEquals('erp5 AND (portal_type:Document OR portal_type:Presentation OR portal_type:"Web Page")', \
1054 1055 1056
                      search_string)
    self.assertSameSet(['searchabletext', 'portal_type'], \
                        parsed_string.keys())
1057
    #self.assertEquals(kw['search_portal_type'], parsed_string['portal_type'])
1058

1059
    # parse with multiple portal_type containing spaces in one portal_type
1060
    search_string = 'erp5 AND (portal_type:Document OR portal_type:Presentation OR portal_type:"Web Page")'
1061
    parsed_string = parse(search_string)
Ivan Tyagov's avatar
Ivan Tyagov committed
1062
    self.assertEquals(parsed_string['portal_type'], ['Document','Presentation','"Web Page"'])
1063

Ivan Tyagov's avatar
Ivan Tyagov committed
1064
  def test_11_Base_getAdvancedSearchResultList(self):
1065
    """
Ivan Tyagov's avatar
Ivan Tyagov committed
1066
    Test search string search capabilities using Base_getAdvancedSearchResultList script.
1067 1068 1069 1070 1071 1072 1073 1074
    """
    portal = self.portal
    assemble = portal.Base_assembleSearchString
    search = portal.Base_getAdvancedSearchResultList

    def getAdvancedSearchStringResultList(**kw):
      search_string = assemble(**kw)
      return [x.getObject() for x in search(search_string)]
1075

1076 1077 1078 1079 1080 1081 1082 1083 1084
    # create some objects
    document_1 = portal.document_module.newContent(
                   portal_type = 'File',
                   description = 'standalone software linux python free',
                   version = '001',
                   language = 'en',
                   reference = 'nxd-test-doc-1')
    document_2 = portal.document_module.newContent(
                   portal_type = 'Presentation',
1085
                   description = 'standalone free python linux knowledge system management different',
1086 1087 1088 1089 1090 1091 1092 1093 1094
                   version = '002',
                   language = 'fr',
                   reference = 'nxd-test-doc-2')
    document_3 = portal.document_module.newContent(
                   portal_type = 'Presentation',
                   description = 'just a copy',
                   version = '003',
                   language = 'en',
                   reference = 'nxd-test-doc-2')
1095
    # multiple revisions of a Web Page
1096 1097
    web_page_1 = portal.web_page_module.newContent(
                   portal_type = 'Web Page',
1098
                   text_content = 'software based solutions document management product standalone owner different',
1099 1100 1101
                   version = '003',
                   language = 'jp',
                   reference = 'nxd-test-web-page-3')
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
    web_page_2 = portal.web_page_module.newContent(
                   portal_type = 'Web Page',
                   text_content = 'new revision (004) of nxd-test-web-page-3',
                   version = '004',
                   language = 'jp',
                   reference = 'nxd-test-web-page-3')
    web_page_3 = portal.web_page_module.newContent(
                   portal_type = 'Web Page',
                   text_content = 'new revision (005) of nxd-test-web-page-3',
                   version = '005',
                   language = 'jp',
                   reference = 'nxd-test-web-page-3')
    # publish documents so we can test searching within owned documents for an user
    for document in (document_1, document_2, document_3, web_page_1, web_page_2, web_page_3):
      document.publish()
    # create test Person objects and add pseudo local security
    person1 =  self.createUser(reference='user1')
    person1.setTitle('Another Contributor')
    portal.document_module.manage_setLocalRoles('user1', ['Assignor',])
    self.stepTic()

    # login as another user
1124
    super(TestDocument, self).login('user1')
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
    document_4 = portal.document_module.newContent(
                   portal_type = 'Presentation',
                   description = 'owner different user contributing document',
                   version = '003',
                   language = 'bg',
                   reference = 'tlv-test-doc-1')
    contributor_list = document_4.getContributorValueList()
    contributor_list.append(person1)
    document_4.setContributorValueList(contributor_list)
    document_4.publish()
1135
    self.stepTic()
1136
    self.login()
1137 1138 1139 1140 1141 1142

    # search arbitrary word
    kw = {'searchabletext_any': 'software'}
    self.assertSameSet([document_1,web_page_1], getAdvancedSearchStringResultList(**kw))
    
    # exact word search
1143 1144
    kw = {'searchabletext_any': '*',
          'searchabletext_phrase': 'linux python'}
1145
    self.assertSameSet([document_1], getAdvancedSearchStringResultList(**kw))
1146 1147
    kw = {'searchabletext_any': '*',
          'searchabletext_phrase': 'python linux'}
1148
    self.assertSameSet([document_2], getAdvancedSearchStringResultList(**kw))
1149
    kw = {'searchabletext_any': '*',
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
          'searchabletext_phrase': 'python linux knowledge system'}
    self.assertSameSet([document_2], getAdvancedSearchStringResultList(**kw))
    
    # search "with all of the words" - each word prefixed by "+"
    kw = {'searchabletext_any': 'standalone',
          'searchabletext_all': 'python'}
    self.assertSameSet([document_1, document_2], getAdvancedSearchStringResultList(**kw))
    
    # search without these words - every word prefixed by "-"
    kw = {'searchabletext_any': 'standalone',
          'searchabletext_without': 'python'}
    self.assertSameSet([web_page_1], getAdvancedSearchStringResultList(**kw))
   
    # only given portal_types - add "type:Type" or type:(Type1,Type2...)
    kw = {'searchabletext_any': 'python',
          'search_portal_type': 'Presentation'}
    self.assertSameSet([document_2], getAdvancedSearchStringResultList(**kw))
1167 1168 1169 1170 1171 1172
    kw = {'searchabletext_any': 'python',
          'search_portal_type': 'File'}
    self.assertSameSet([document_1], getAdvancedSearchStringResultList(**kw))
    kw = {'searchabletext_any': 'management',
          'search_portal_type': 'File'}
    self.assertSameSet([], getAdvancedSearchStringResultList(**kw))
1173 1174
   
    # search by reference
1175
    kw = {'reference': document_2.getReference()}
1176 1177 1178 1179
    self.assertSameSet([document_2, document_3], getAdvancedSearchStringResultList(**kw))
    kw = {'searchabletext_any': 'copy',
          'reference': document_2.getReference()}
    self.assertSameSet([document_3], getAdvancedSearchStringResultList(**kw))
1180 1181
    kw = {'searchabletext_any': 'copy',
          'reference': document_2.getReference(),
1182
          'search_portal_type': 'File'}
1183
    self.assertSameSet([], getAdvancedSearchStringResultList(**kw))
1184 1185
  
    # search by version
1186
    kw = {'reference': document_2.getReference(),
1187
          'version': document_2.getVersion()}
1188
    self.assertSameSet([document_2], getAdvancedSearchStringResultList(**kw))
1189
    kw = {'reference': document_2.getReference(),
1190 1191 1192
          'version': document_2.getVersion(),
          'search_portal_type': 'File'}
    self.assertSameSet([], getAdvancedSearchStringResultList(**kw))
1193 1194
   
    # search by language
1195
    kw = {'reference': document_2.getReference(),
1196 1197
          'language': document_2.getLanguage()}
    self.assertSameSet([document_2], getAdvancedSearchStringResultList(**kw))
1198
    kw = {'reference': document_2.getReference(),
1199 1200
          'language': document_3.getLanguage()}
    self.assertSameSet([document_3], getAdvancedSearchStringResultList(**kw))
1201
    kw = {'reference': document_2.getReference(),
1202
          'language': document_3.getLanguage(),
1203
          'search_portal_type': 'File'}
1204
    self.assertSameSet([], getAdvancedSearchStringResultList(**kw))
1205
  
1206
    # only my docs
1207
    super(TestDocument, self).login('user1')
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
    kw = {'searchabletext_any': 'owner'}
    # should return all documents matching a word no matter if we're owner or not
    self.assertSameSet([web_page_1, document_4], getAdvancedSearchStringResultList(**kw))
    kw = {'searchabletext_any': 'owner',
          'mine': 'yes'}
    # should return ONLY our own documents matching a word
    self.assertSameSet([document_4], getAdvancedSearchStringResultList(**kw))
    self.login()
    
    # only newest versions
    # should return ALL documents for a reference
    kw = {'reference': web_page_1.getReference()}
    self.assertSameSet([web_page_1, web_page_2, web_page_3], getAdvancedSearchStringResultList(**kw))
    # should return ONLY newest document for a reference
    kw = {'reference': web_page_1.getReference(),
          'newest': 'yes'}
    self.assertSameSet([web_page_3], getAdvancedSearchStringResultList(**kw))

    # contributor title search
    kw = {'searchabletext_any': 'owner'}
    # should return all documents matching a word no matter of contributor
    self.assertSameSet([web_page_1, document_4], getAdvancedSearchStringResultList(**kw))
    kw = {'searchabletext_any': 'owner',
          'contributor_title': '%Contributor%'}
    self.assertSameSet([document_4], getAdvancedSearchStringResultList(**kw))
1233 1234 1235 1236 1237

    # multiple portal_type specified
    kw = {'search_portal_type': 'File,Presentation'}
    self.assertSameSet([document_1, document_2, document_3, document_4], getAdvancedSearchStringResultList(**kw))

1238
    # XXX: search limited to a certain date range
1239 1240
    # XXX: search mode

1241 1242 1243 1244 1245 1246 1247
  def test_PDFTextContent(self):
    upload_file = makeFileUpload('REF-en-001.pdf')
    document = self.portal.portal_contributions.newContent(file=upload_file)
    self.assertEquals('PDF', document.getPortalType())
    self.assertEquals('I use reference to look up TEST\n',
                      document._convertToText())
    self.assert_('I use reference to look up TEST' in
1248
                 document._convertToHTML().replace('&nbsp;', ' '))
1249 1250 1251
    self.assert_('I use reference to look up TEST' in
                 document.SearchableText())

1252 1253 1254 1255
  def test_PDFToImage(self):
    upload_file = makeFileUpload('REF-en-001.pdf')
    document = self.portal.portal_contributions.newContent(file=upload_file)
    self.assertEquals('PDF', document.getPortalType())
Nicolas Delaby's avatar
Nicolas Delaby committed
1256

1257
    content_type, image_data = document.convert(format='png',
Nicolas Delaby's avatar
Nicolas Delaby committed
1258 1259
                                                frame=0,
                                                display='thumbnail')
1260 1261
    # it's a valid PNG
    self.assertEquals('PNG', image_data[1:4])
Fabien Morin's avatar
Fabien Morin committed
1262

1263 1264 1265 1266 1267 1268 1269 1270
  def test_PDF_content_information(self):
    upload_file = makeFileUpload('REF-en-001.pdf')
    document = self.portal.portal_contributions.newContent(file=upload_file)
    self.assertEquals('PDF', document.getPortalType())
    content_information = document.getContentInformation()
    self.assertEquals('1', content_information['Pages'])
    self.assertEquals('subject', content_information['Subject'])
    self.assertEquals('title', content_information['Title'])
1271
    self.assertEquals('application/pdf', document.getContentType())
1272

1273 1274 1275
  def test_PDF_content_information_extra_metadata(self):
    # Extra metadata, such as those stored by pdftk update_info are also
    # available in document.getContentInformation()
1276
    upload_file = makeFileUpload('metadata.pdf', as_name='REF-en-001.pdf')
1277
    document = self.portal.portal_contributions.newContent(file=upload_file)
1278
    self.stepTic()
1279 1280
    self.assertEquals('PDF', document.getPortalType())
    content_information = document.getContentInformation()
1281
    self.assertEquals('the value', content_information['NonStandardMetadata'])
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
    self.assertEquals('1', content_information['Pages'])
    self.assertEquals('REF', document.getReference())

    # contribute file which will be merged to current document in synchronous mode
    # and check content_type recalculated 
    upload_file = makeFileUpload('Forty-Two.Pages-en-001.pdf', as_name='REF-en-001.pdf')
    contributed_document = self.portal.Base_contribute(file=upload_file, \
                                                       synchronous_metadata_discovery=True)
    self.stepTic()
    content_information = contributed_document.getContentInformation()
    
    # we should have same data, respectively same PDF pages
    self.assertEqual(contributed_document.getSize(), document.getSize())
    self.assertEqual(contributed_document.getContentInformation()['Pages'], \
                     document.getContentInformation()['Pages'])
    self.assertEqual('42', \
                     document.getContentInformation()['Pages'])

    # upload with another file and check content_type recalculated
    upload_file = makeFileUpload('REF-en-001.pdf')
    document.setFile(upload_file)
    self.stepTic()
    content_information = document.getContentInformation()
    self.assertEquals('1', content_information['Pages'])    
1306

1307 1308
  def test_PDF_content_content_type(self):
    upload_file = makeFileUpload('REF-en-001.pdf')
1309 1310
    document = self.portal.document_module.newContent(portal_type='PDF')
    # Here we use edit instead of setFile,
Nicolas Delaby's avatar
Nicolas Delaby committed
1311
    # because only edit method set filename as filename.
1312
    document.edit(file=upload_file)
1313
    self.assertEquals('application/pdf', document.getContentType())
1314

Nicolas Delaby's avatar
Nicolas Delaby committed
1315
  def test_Document_getStandardFilename(self):
1316 1317 1318
    upload_file = makeFileUpload('metadata.pdf')
    document = self.portal.document_module.newContent(portal_type='PDF')
    document.edit(file=upload_file)
Nicolas Delaby's avatar
Nicolas Delaby committed
1319 1320
    self.assertEquals(document.getStandardFilename(), 'metadata.pdf')
    self.assertEquals(document.getStandardFilename(format='png'),
1321 1322 1323
                      'metadata.png')
    document.setVersion('001')
    document.setLanguage('en')
Nicolas Delaby's avatar
Nicolas Delaby committed
1324 1325
    self.assertEquals(document.getStandardFilename(), 'metadata-001-en.pdf')
    self.assertEquals(document.getStandardFilename(format='png'),
1326
                      'metadata-001-en.png')
1327 1328 1329 1330
    # check when format contains multiple '.'
    upload_file = makeFileUpload('TEST-en-003.odp')
    document = self.portal.document_module.newContent(portal_type='Presentation')
    document.edit(file=upload_file)
Nicolas Delaby's avatar
Nicolas Delaby committed
1331 1332
    self.assertEquals(document.getStandardFilename(), 'TEST-en-003.odp')
    self.assertEquals('TEST-en-003.odg', document.getStandardFilename(format='odp.odg'))
1333

1334

1335 1336 1337 1338
  def test_CMYKImageTextContent(self):
    upload_file = makeFileUpload('cmyk_sample.jpg')
    document = self.portal.portal_contributions.newContent(file=upload_file)
    self.assertEquals('Image', document.getPortalType())
1339
    self.assertEquals('ERP5 is a free software\n\n', document.asText())
1340

1341 1342 1343 1344 1345
  def test_Base_showFoundText(self):
    # Create document with good content
    document = self.portal.document_module.newContent(portal_type='Drawing')
    self.assertEquals('empty', document.getExternalProcessingState())

1346
    upload_file = makeFileUpload('TEST-en-002.odt')
1347
    document.edit(file=upload_file)
1348
    self.stepTic()
1349 1350
    self.assertEquals('converted', document.getExternalProcessingState())

Nicolas Delaby's avatar
Nicolas Delaby committed
1351 1352
    # Delete base_data
    document.edit(base_data=None)
1353
    
Nicolas Delaby's avatar
Nicolas Delaby committed
1354
    # As document is not converted, text conversion is impossible
1355 1356
    self.assertRaises(NotConvertedError, document.asText)
    self.assertRaises(NotConvertedError, document.getSearchableText)
Fabien Morin's avatar
Fabien Morin committed
1357
    self.assertEquals('This document is not converted yet.',
1358
                      document.Base_showFoundText())
1359 1360 1361 1362 1363 1364
    
    # upload again good content
    upload_file = makeFileUpload('TEST-en-002.odt')
    document.edit(file=upload_file)
    self.stepTic()
    self.assertEquals('converted', document.getExternalProcessingState())
1365

1366
  def test_Base_createNewFile(self):
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
    """
      Test contributing a file and attaching it to context.
    """
    person = self.portal.person_module.newContent(portal_type='Person')
    contributed_document = person.Base_contribute(
                                     portal_type=None,
                                     title=None,
                                     reference=None,
                                     short_title=None,
                                     language=None,
                                     version=None,
                                     description=None,
                                     attach_document_to_context=True,
                                     file=makeFileUpload('TEST-en-002.odt'))
    self.assertEquals('Text', contributed_document.getPortalType())
    self.stepTic()
    document_list = person.getFollowUpRelatedValueList()
1384 1385 1386 1387 1388
    self.assertEquals(1, len(document_list))
    document = document_list[0]
    self.assertEquals('converted', document.getExternalProcessingState())
    self.assertEquals('Text', document.getPortalType())
    self.assertEquals('title', document.getTitle())
1389
    self.assertEquals(contributed_document, document)
1390 1391

  def test_Base_createNewFile_empty(self):
Ivan Tyagov's avatar
Typo.  
Ivan Tyagov committed
1392
    """
1393 1394 1395
      Test contributing an empty file and attaching it to context.
    """
    person = self.portal.person_module.newContent(portal_type='Person')
1396 1397 1398 1399 1400 1401
    empty_file_upload = ZPublisher.HTTPRequest.FileUpload(FieldStorage(
                            fp=StringIO.StringIO(),
                            environ=dict(REQUEST_METHOD='PUT'),
                            headers={"content-disposition":
                              "attachment; filename=empty;"}))

1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413
    contributed_document = person.Base_contribute(
                                    portal_type=None,
                                    title=None,
                                    reference=None,
                                    short_title=None,
                                    language=None,
                                    version=None,
                                    description=None,
                                    attach_document_to_context=True,
                                    file=empty_file_upload)
    self.stepTic()
    document_list = person.getFollowUpRelatedValueList()
1414 1415 1416
    self.assertEquals(1, len(document_list))
    document = document_list[0]
    self.assertEquals('File', document.getPortalType())
1417
    self.assertEquals(contributed_document, document)
1418

1419 1420 1421 1422 1423 1424 1425 1426 1427
  def test_Base_createNewFile_forced_type(self):
    """Test contributing while forcing the portal type.
    """
    person = self.portal.person_module.newContent(portal_type='Person')
    contributed_document = person.Base_contribute(
                                     portal_type='PDF',
                                     file=makeFileUpload('TEST-en-002.odt'))
    self.assertEquals('PDF', contributed_document.getPortalType())

1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
  def test_HTML_to_ODT_conversion_keep_enconding(self):
    """This test perform an PDF conversion of HTML content
    then to plain text.
    Check that encoding remains.
    """
    web_page_portal_type = 'Web Page'
    string_to_test = 'éààéôù'
    web_page = self.portal.getDefaultModule(web_page_portal_type)\
          .newContent(portal_type=web_page_portal_type)
    html_content = '<p>%s</p>' % string_to_test
    web_page.edit(text_content=html_content)
    mime_type, pdf_data = web_page.convert('pdf')
    text_content = self.portal.portal_transforms.\
                                      convertToData('text/plain',
                                          str(pdf_data),
                                          object=web_page, context=web_page,
                                          filename='test.pdf')
    self.assertTrue(string_to_test in text_content)
1446

1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
  def test_HTML_to_ODT_conversion_keep_related_image_list(self):
    """This test create a Web Page and an Image.
    HTML content of Web Page referred to that Image with it's reference.
    Check that ODT conversion of Web Page embed image data.
    """
    # create web page
    web_page_portal_type = 'Web Page'
    web_page = self.portal.getDefaultModule(web_page_portal_type)\
          .newContent(portal_type=web_page_portal_type)
    image_reference = 'MY-TESTED-IMAGE'
    # Target image with it reference only
    html_content = '<p><img src="%s"/></p>' % image_reference
    web_page.edit(text_content=html_content)

    # Create image
    image_portal_type = 'Image'
    image = self.portal.getDefaultModule(image_portal_type)\
          .newContent(portal_type=image_portal_type)

1466
    # edit content and publish it
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
    upload_file = makeFileUpload('cmyk_sample.jpg')
    image.edit(reference=image_reference,
               version='001',
               language='en',
               file=upload_file)
    image.publish()

    transaction.commit()
    self.tic()

    # convert web_page into odt
    mime_type, odt_archive = web_page.convert('odt')
    builder = OOoBuilder(odt_archive)
    image_count = builder._image_count
1481 1482
    failure_message = 'Expected image not found in ODF zipped archive'
    # fetch image from zipped archive content then compare with ERP5 Image
1483 1484
    self.assertEquals(builder.extract('Pictures/%s.jpeg' % image_count),
                      image.getData(), failure_message)
1485

1486 1487 1488
    # Continue the test with image resizing support
    image_display = 'large'
    # Add url parameters
1489
    html_content = '<p><img src="%s?format=jpeg&amp;display=%s&amp;quality=75"/></p>' % \
1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501
                                              (image_reference, image_display)
    web_page.edit(text_content=html_content)
    mime_type, odt_archive = web_page.convert('odt')
    builder = OOoBuilder(odt_archive)
    image_count = builder._image_count
    # compute resized image for comparison
    mime, converted_image = image.convert(format='jpeg', display=image_display)
    # fetch image from zipped archive content
    # then compare with resized ERP5 Image
    self.assertEquals(builder.extract('Pictures/%s.jpeg' % image_count),
                      converted_image, failure_message)

1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
    # Let's continue with Presentation Document as embbeded image
    document = self.portal.document_module.newContent(portal_type='Presentation')
    upload_file = makeFileUpload('TEST-en-003.odp')
    image_reference = 'IMAGE-odp'
    document.edit(file=upload_file, reference=image_reference)
    document.publish()
    transaction.commit()
    self.tic()
    html_content = '<p><img src="%s?format=png&amp;display=%s&amp;quality=75"/></p>' % \
                                              (image_reference, image_display)
    web_page.edit(text_content=html_content)
    mime_type, odt_archive = web_page.convert('odt')
    builder = OOoBuilder(odt_archive)
    image_count = builder._image_count
    # compute resized image for comparison
    mime, converted_image = document.convert(format='png',
                                             display=image_display,
                                             quality=75)
    # fetch image from zipped archive content
    # then compare with resized ERP5 Image
    self.assertEquals(builder.extract('Pictures/%s.png' % image_count),
                      converted_image, failure_message)


1526 1527 1528 1529 1530 1531 1532 1533
  def test_addContributorToDocument(self):
    """
      Test if current authenticated user is added to contributor list of document
      (only if authenticated user is an ERP5 Person object)
    """
    portal = self.portal
    document_module = portal.document_module

1534
    # create Person objects and add pseudo local security
1535 1536 1537 1538
    person1 =  self.createUser(reference='contributor1')
    document_module.manage_setLocalRoles('contributor1', ['Assignor',])
    person2 =  self.createUser(reference='contributor2')
    document_module.manage_setLocalRoles('contributor2', ['Assignor',])
1539 1540 1541
    self.stepTic()

    # login as first one
1542
    super(TestDocument, self).login('contributor1')
1543 1544 1545 1546 1547 1548 1549 1550
    doc = document_module.newContent(portal_type='File', 
                                     title='Test1')
    self.stepTic()
    self.login()
    self.assertSameSet([person1], 
                       doc.getContributorValueList())

    # login as second one
1551
    super(TestDocument, self).login('contributor2')
1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
    doc.edit(title='Test2')
    self.stepTic()
    self.login()
    self.assertSameSet([person1, person2], 
                       doc.getContributorValueList())

    # editing with non ERP5 Person object, nothing added to contributor
    self.login()
    doc.edit(title='Test3')
    self.stepTic()
    self.assertSameSet([person1, person2], 
                       doc.getContributorValueList())
1564

1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
  def test_safeHTML_conversion(self):
    """This test create a Web Page and test asSafeHTML conversion.
    Test also with a very non well-formed html document
    to stress conversion engine.
    """
    # create web page
    web_page_portal_type = 'Web Page'
    module = self.portal.getDefaultModule(web_page_portal_type)
    web_page = module.newContent(portal_type=web_page_portal_type)

    html_content = """<html>
      <head>
1577 1578
        <meta http-equiv="refresh" content="5;url=http://example.com/"/>
        <meta http-equiv="Set-Cookie" content=""/>
1579
        <title>My dirty title</title>
1580 1581 1582
        <style type="text/css">
          a {color: #FFAA44;}
        </style>
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1583
        <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
1584 1585 1586 1587 1588 1589
      </head>
      <body>
        <div>
          <h1>My splendid title</h1>
        </div>
        <script type="text/javascript" src="http://example.com/something.js"/>
1590 1591 1592 1593 1594
        <script type="text/javascript">
          alert("da");
        </script>
        <a href="javascript:DosomethingNasty()">Link</a>
        <a onClick="javascript:DosomethingNasty()">Another Link</a>
1595
        <p>éàèù</p>
1596
        <p class="Th&#232;mes Thèmes">Th&#232;mes Thèmes</p>
1597 1598
      </body>
    </html>
1599
    """.decode('utf-8').encode('iso-8859-1')
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
    # content encoded into another codec
    # than utf-8 comes from necessarily an external file
    # (Ingestion, or FileField), not from user interface 
    # which is always utf-8.
    # Edit web_page with a file to force conversion to base_format
    # as it is done in reality

    # Mimic the behaviour of a FileUpload from WebPage_view
    file_like = StringIO.StringIO()
    file_like.write(html_content)
    setattr(file_like, 'filename', 'something.htm')
    web_page.edit(file=file_like)
    # run conversion to base format
    transaction.commit() 
    self.tic()
1615

1616
    # Check that outputted stripped html is safe
1617
    safe_html = web_page.asStrippedHTML()
1618 1619 1620
    self.assertTrue('My splendid title' in safe_html)
    self.assertTrue('script' not in safe_html, safe_html)
    self.assertTrue('something.js' not in safe_html, safe_html)
1621 1622 1623 1624
    self.assertTrue('<body>' not in safe_html)
    self.assertTrue('<head>' not in safe_html)
    self.assertTrue('<style' not in safe_html)
    self.assertTrue('#FFAA44' not in safe_html)
1625 1626
    self.assertTrue('5;url=http://example.com/' not in safe_html)
    self.assertTrue('Set-Cookie' not in safe_html)
1627 1628 1629 1630
    self.assertTrue('javascript' not in safe_html)
    self.assertTrue('alert("da");' not in safe_html)
    self.assertTrue('javascript:DosomethingNasty()' not in safe_html)
    self.assertTrue('onClick' not in safe_html)
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641

    # Check that outputed entire html is safe
    entire_html = web_page.asEntireHTML()
    self.assertTrue('My splendid title' in entire_html)
    self.assertTrue('script' not in entire_html, entire_html)
    self.assertTrue('something.js' not in entire_html, entire_html)
    self.assertTrue('<title>' in entire_html)
    self.assertTrue('<body>' in entire_html)
    self.assertTrue('<head>' in entire_html)
    self.assertTrue('<style' in entire_html)
    self.assertTrue('#FFAA44' in entire_html)
1642
    self.assertTrue('charset=utf-8' in entire_html)
1643 1644 1645 1646
    self.assertTrue('javascript' not in entire_html)
    self.assertTrue('alert("da");' not in entire_html)
    self.assertTrue('javascript:DosomethingNasty()' not in entire_html)
    self.assertTrue('onClick' not in entire_html)
1647 1648

    # now check converted value is stored in cache
1649
    format = 'html'
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
    self.assertTrue(web_page.hasConversion(format=format))
    web_page.edit(text_content=None)
    self.assertFalse(web_page.hasConversion(format=format))

    # test with not well-formed html document
    html_content = """
    <HTML dir=3Dltr><HEAD>=0A=
<META http-equiv=3DContent-Type content=3D"text/html; charset=3Dunicode">=0A=
<META content=3D"DIRTYHTML 6.00.2900.2722" name=3DGENERATOR></HEAD>=0A=

<BODY>=0A=
<DIV><FONT face=3D"Times New Roman" color=3D#000000 size=3D3>blablalba</FONT></DIV>=0A=
<DIV>&nbsp;</DIV>=0A=
<DIV></DIV>=0A=
<DIV>&nbsp;</DIV>=0A=
<DIV>&nbsp;</DIV>=0A=
<DIV>&nbsp;</DIV>=0A=
<br>=
<!DOCTYPE html PUBLIC \\\"-//W3C//DTD XHTML 1.0 Transitional//EN\\\\=
" \\\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\\\">=
=0A<html xmlns=3D\\\"http://www.w3.org/1999/xhtml\\\">=0A<head>=0A<m=
eta http-equiv=3D\\\"Content-Type\\\" content=3D\\\"text/html; c=
harset=3Diso-8859-1\\\" />=0A<style type=3D\\\"text/css\\\">=0A<=
!--=0A.style1 {font-size: 8px}=0A.style2 {font-family: Arial, Helvetica, san=
s-serif}=0A.style3 {font-size: 8px; font-family: Arial, Helvetica, sans-seri=
f; }=0A-->=0A</style>=0A</head>=0A=0A<body>=0A<div>=0A  <p><span class=3D\\=
\\"style1\\\"><span class=3D\\\"style2\\\"><strong>I'm inside very broken HTML code</strong><br />=0A    ERP5<br />=0A
ERP5
<br />=0A    =
</span></span></p>=0A  <p class=3D\\\"sty=
le3\\\">ERP5:<br />=0A   </p>=0A  <p class=3D\\\"style3\\\"><strong>ERP5</strong>=

<br />=0A    ERP5</p>=0A</di=
v>=0A</body>=0A</html>=0A
<br>=
Nicolas Delaby's avatar
Nicolas Delaby committed
1685 1686
<!-- This is a comment, This string AZERTYY shouldn't be dislayed-->
<style>
1687
<!-- a {color: #FFAA44;} -->
Nicolas Delaby's avatar
Nicolas Delaby committed
1688
</style>
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700
<table class=3DMoNormalTable border=3D0 cellspacing=3D0 cellpadding=3D0 =
width=3D64
 style=3D'width:48.0pt;margin-left:-.75pt;border-collapse:collapse'>
 <tr style=3D'height:15.0pt'>
  <td width=3D64 nowrap valign=3Dbottom =
style=3D'width:48.0pt;padding:0cm 5.4pt 0cm 5.4pt;
  height:15.0pt'>
  <p class=3DMoNormal><span =
style=3D'color:black'>05D65812<o:p></o:p></span></p>
  </td>
 </tr>
</table>
1701 1702 1703
<script LANGUAGE="JavaScript" type="text/javascript">
document.write('<sc'+'ript type="text/javascript" src="http://somosite.bg/utb.php"></sc'+'ript>');
</script>
1704
<p class="Th&#232;mes">Th&#232;mes</p>
1705 1706 1707
</BODY></HTML>
    """
    web_page.edit(text_content=html_content)
1708
    safe_html = web_page.asStrippedHTML()
1709 1710
    self.assertTrue('inside very broken HTML code' in safe_html)
    self.assertTrue('AZERTYY' not in safe_html)
1711
    self.assertTrue('#FFAA44' in safe_html)
1712

1713 1714 1715 1716 1717
    filename = 'broken_html.html'
    file_object = makeFileUpload(filename)
    web_page.edit(file=file_object)
    converted = web_page.convert('html')[1]

Nicolas Delaby's avatar
Nicolas Delaby committed
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
  def test_safeHTML_impossible_conversion(self):
    """Some html are not parsable.
    """
    web_page_portal_type = 'Web Page'
    module = self.portal.getDefaultModule(web_page_portal_type)
    web_page = module.newContent(portal_type=web_page_portal_type)
    # very dirty html
    html_content = """
    <html>
      <body>
        <p><a href="http://www.example.com/category/html/" style="font-weight: bold; color: rgb(0, 0, 0); font-size: 90.8777%; text-decoration: none;" title="catégorie how to write valid html d" alt="Diancre pas d" accord="" :="" 6="" articles="">Its french</a></p>
      </body>
    </html>
"""
    web_page.edit(text_content=html_content)
1733
    from HTMLParser import HTMLParseError
Nicolas Delaby's avatar
Nicolas Delaby committed
1734 1735
    try:
      web_page.asStrippedHTML()
1736 1737 1738
    except HTMLParseError:
      expectedFailure(self.fail)(
        'Even BeautifulSoup is not able to parse such HTML')
Nicolas Delaby's avatar
Nicolas Delaby committed
1739

1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
  def test_safeHTML_unknown_codec(self):
    """Some html declare unknown codecs.
    """
    web_page_portal_type = 'Web Page'
    module = self.portal.getDefaultModule(web_page_portal_type)
    web_page = module.newContent(portal_type=web_page_portal_type)

    html_content = """
    <html>
      <head>
        <meta http-equiv="Content-Type" content="text/html; charset=unicode" />
        <title>BLa</title>
      </head>
      <body><p> blablabla</p></body>
    </html>"""
    web_page.edit(text_content=html_content)
    safe_html = web_page.convert('html')[1]
    self.assertTrue('unicode' not in safe_html)
    self.assertTrue('utf-8' in safe_html)

1760 1761
  def test_parallel_conversion(self):
    """Check that conversion engine is able to fill in
Arnaud Fontaine's avatar
Arnaud Fontaine committed
1762
    cache without overwriting previous conversion
1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
    when processed at the same time.
    """
    portal_type = 'PDF'
    document_module = self.portal.getDefaultModule(portal_type)
    document = document_module.newContent(portal_type=portal_type)

    upload_file = makeFileUpload('Forty-Two.Pages-en-001.pdf')
    document.edit(file=upload_file)
    pages_number = int(document.getContentInformation()['Pages'])
    transaction.commit()
    self.tic()

1775 1776 1777 1778 1779 1780 1781 1782
    preference_tool = getToolByName(self.portal, 'portal_preferences')
    image_size = preference_tool.getPreferredThumbnailImageHeight(),\
                              preference_tool.getPreferredThumbnailImageWidth()
    convert_kw = {'format': 'png',
                  'quality': 75,
                  'display': 'thumbnail',
                  'resolution': None}

1783
    class ThreadWrappedConverter(Thread):
Arnaud Fontaine's avatar
Arnaud Fontaine committed
1784
      """Use this class to run different conversions
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
      inside distinct Thread.
      """
      def __init__(self, publish_method, document_path,
                   frame_list, credential):
        self.publish_method = publish_method
        self.document_path = document_path
        self.frame_list = frame_list
        self.credential = credential
        Thread.__init__(self)

      def run(self):
        for frame in self.frame_list:
          # Use publish method to dispatch conversion among
1798 1799 1800 1801
          # all available ZServer threads.
          convert_kw['frame'] = frame
          response = self.publish_method(self.document_path,
                                         basic=self.credential,
1802
                                         extra=convert_kw.copy())
1803 1804 1805 1806

          assert response.getHeader('content-type') == 'image/png', \
                                             response.getHeader('content-type')
          assert response.getStatus() == httplib.OK
1807 1808 1809 1810 1811
        transaction.commit()

    # assume there is no password
    credential = '%s:' % (getSecurityManager().getUser().getId(),)
    tested_list = []
Arnaud Fontaine's avatar
Arnaud Fontaine committed
1812
    frame_list = range(pages_number)
1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
    # assume that ZServer is configured with 4 Threads
    conversion_per_tread = pages_number / 4
    while frame_list:
      local_frame_list = [frame_list.pop() for i in\
                            xrange(min(conversion_per_tread, len(frame_list)))]
      instance = ThreadWrappedConverter(self.publish, document.getPath(),
                                        local_frame_list, credential)
      tested_list.append(instance)
      instance.start()

    # Wait until threads finishing
    [tested.join() for tested in tested_list]

    transaction.commit()
    self.tic()

    convert_kw = {'format': 'png',
                  'quality': 75,
1831
                  'display': 'thumbnail',
1832 1833
                  'resolution': None}

1834 1835 1836
    result_list = []
    for i in xrange(pages_number):
      # all conversions should succeeded and stored in cache storage
1837
      convert_kw['frame'] = i
1838 1839 1840 1841
      if not document.hasConversion(**convert_kw):
        result_list.append(i)
    self.assertEquals(result_list, [])

1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
  def test_conversionCache_reseting(self):
    """Chack that modifying a document with edit method,
    compute a new cache key and refresh cached conversions.
    """
    web_page_portal_type = 'Web Page'
    module = self.portal.getDefaultModule(web_page_portal_type)
    web_page = module.newContent(portal_type=web_page_portal_type)
    html_content = """<html>
      <head>
        <title>My dirty title</title>
        <style type="text/css">
          a {color: #FFAA44;}
        </style>
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
1855
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873
     </head>
      <body>
        <div>
          <h1>My splendid title</h1>
        </div>
        <script type="text/javascript" src="http://example.com/something.js"/>
      </body>
    </html>
    """
    web_page.edit(text_content=html_content)
    web_page.convert(format='txt')
    self.assertTrue(web_page.hasConversion(format='txt'))
    web_page.edit(title='Bar')
    self.assertFalse(web_page.hasConversion(format='txt'))
    web_page.convert(format='txt')
    web_page.edit()
    self.assertFalse(web_page.hasConversion(format='txt'))

Nicolas Delaby's avatar
Nicolas Delaby committed
1874 1875 1876 1877 1878 1879 1880 1881
  def test_TextDocument_conversion_to_base_format(self):
    """Check that any files is converted into utf-8
    """
    web_page_portal_type = 'Web Page'
    module = self.portal.getDefaultModule(web_page_portal_type)
    upload_file = makeFileUpload('TEST-text-iso8859-1.txt')
    web_page = module.newContent(portal_type=web_page_portal_type,
                                 file=upload_file)
Nicolas Delaby's avatar
Nicolas Delaby committed
1882 1883
    transaction.commit()
    self.tic()
Nicolas Delaby's avatar
Nicolas Delaby committed
1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
    text_content = web_page.getTextContent()
    my_utf_eight_token = 'ùééàçèîà'
    text_content = text_content.replace('\n', '\n%s\n' % my_utf_eight_token)
    web_page.edit(text_content=text_content)
    self.assertTrue(my_utf_eight_token in web_page.asStrippedHTML())
    self.assertTrue(isinstance(web_page.asEntireHTML().decode('utf-8'), unicode))

  def test_PDFDocument_asTextConversion(self):
    """Test a PDF document with embedded images
    To force usage of Ocropus portal_transform chain
    """
    portal_type = 'PDF'
    module = self.portal.getDefaultModule(portal_type)
    upload_file = makeFileUpload('TEST.Embedded.Image.pdf')
    document = module.newContent(portal_type=portal_type, file=upload_file)
1899
    self.assertEquals(document.asText(), 'ERP5 is a free software\n\n')
Nicolas Delaby's avatar
Nicolas Delaby committed
1900

1901
  def createRestrictedSecurityHelperScript(self):
1902
    script_content_list = ['format=None, **kw', """
1903 1904 1905
if not format:
  return 0
return 1
1906 1907 1908 1909 1910
"""]
    for script_id in self.conversion_format_permission_script_id_list:
      createZODBPythonScript(self.getPortal().portal_skins.custom,
      script_id, *script_content_list)
      transaction.commit()
1911 1912

  def _test_document_conversion_to_base_format_no_original_format_access(self,
Nicolas Delaby's avatar
Nicolas Delaby committed
1913
      portal_type, filename):
1914
    module = self.portal.getDefaultModule(portal_type)
Nicolas Delaby's avatar
Nicolas Delaby committed
1915
    upload_file = makeFileUpload(filename)
1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957
    document = module.newContent(portal_type=portal_type,
                                 file=upload_file)

    transaction.commit()
    self.tic()

    self.createRestrictedSecurityHelperScript()

    from AccessControl import Unauthorized
    # check that it is not possible to access document in original format
    self.assertRaises(Unauthorized, document.convert, format=None)
    # check that it is possible to convert document to text format
    dummy = document.convert(format='text')

  def test_WebPage_conversion_to_base_format_no_original_format_access(self):
    """Checks Document.TextDocument"""
    self._test_document_conversion_to_base_format_no_original_format_access(
      'Web Page',
      'TEST-text-iso8859-1.txt'
    )

  def test_PDF_conversion_to_base_format_no_original_format_access(self):
    """Checks Document.PDFDocument"""
    self._test_document_conversion_to_base_format_no_original_format_access(
      'PDF',
      'TEST-en-002.pdf'
    )

  def test_Text_conversion_to_base_format_no_original_format_access(self):
    """Checks Document.OOoDocument"""
    self._test_document_conversion_to_base_format_no_original_format_access(
      'Text',
      'TEST-en-002.odt'
    )

  def test_Image_conversion_to_base_format_no_original_format_access(self):
    """Checks Document.Image"""
    self._test_document_conversion_to_base_format_no_original_format_access(
      'Image',
      'TEST-en-002.png'
    )

1958 1959 1960 1961
  def test_getExtensibleContent(self):
    """
      Test extensible content of some DMS types. As this is possible only on URL traversal use publish.
    """
1962 1963 1964 1965 1966
    # Create a root level zope user
    root_user_folder = self.getPortalObject().aq_parent.acl_users
    if not root_user_folder.getUser('zope_user'):
      root_user_folder._doAddUser('zope_user', '', ['Manager',], [])
      transaction.commit()
1967 1968 1969 1970 1971 1972 1973
    # Create document with good content
    document = self.portal.document_module.newContent(portal_type='Presentation')
    upload_file = makeFileUpload('TEST-en-003.odp')
    document.edit(file=upload_file)
    self.stepTic()
    self.assertEquals('converted', document.getExternalProcessingState())
    for object_url in ('img1.html', 'img2.html', 'text1.html', 'text2.html'):
1974 1975 1976 1977 1978 1979 1980 1981 1982
      for credential in ['ERP5TypeTestCase:', 'zope_user:']:
        response = self.publish('%s/%s' %(document.getPath(), object_url),
                                basic=credential)
        self.assertTrue('Status: 200 OK' in response.getOutput())
        # OOod produced HTML navigation, test it
        self.assertTrue('First page' in response.getBody())
        self.assertTrue('Back' in response.getBody())
        self.assertTrue('Continue' in response.getBody())
        self.assertTrue('Last page' in response.getBody())
1983

1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995
  def test_getTargetFormatItemList(self):
    """
     Test getting target conversion format item list.
     Note: this tests assumes the default formats do exists for some content types.
     as this is a matter of respective oinfiguration of mimetypes_registry & portal_transforms
     only the basic minium of transorm to formats is tested.
    """
    portal_type = 'PDF'
    module = self.portal.getDefaultModule(portal_type)

    upload_file = makeFileUpload('TEST.Large.Document.pdf')
    pdf = module.newContent(portal_type=portal_type, file=upload_file)
1996
    
1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
    self.assertTrue('html' in pdf.getTargetFormatList())
    self.assertTrue('png' in pdf.getTargetFormatList())
    self.assertTrue('txt' in pdf.getTargetFormatList())

    web_page=self.portal.web_page_module.newContent(portal_type='Web Page',
                                                    content_type='text/html')
    self.assertTrue('odt' in web_page.getTargetFormatList())
    self.assertTrue('txt' in web_page.getTargetFormatList())

    image=self.portal.image_module.newContent(portal_type='Image',
                                                    content_type='image/png')
2008
    self.assertTrue(image.getTargetFormatList())
2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
    
    # test Not converted (i.e. empty) OOoDocument instances
    presentation=self.portal.document_module.newContent(portal_type='Presentation')
    self.assertSameSet([], presentation.getTargetFormatList())
    
    # test uploading some data
    upload_file = makeFileUpload('Foo_001.odg')
    presentation.edit(file=upload_file)
    self.stepTic()
    self.assertTrue('odg' in presentation.getTargetFormatList())
    self.assertTrue('jpg' in presentation.getTargetFormatList())
    self.assertTrue('png' in presentation.getTargetFormatList())
2021
  
2022
  def test_convertWebPageWithEmbeddedZODBImageToImageOnTraversal(self):
2023
    """
2024
    Test Web Page using embedded Images into ZODB case (in its HTML body)
2025
    """
Ivan Tyagov's avatar
Ivan Tyagov committed
2026 2027
    display= 'thumbnail'
    convert_kw = {'display':display, 
2028 2029
                  'format':'jpeg', 
                  'quality':100}
Ivan Tyagov's avatar
Ivan Tyagov committed
2030
    preffered_size_for_display = self.getPreferences(display)    
2031
    web_page_document = self.portal.web_page_module.newContent(portal_type="Web Page")
2032 2033
    # use ERP5's favourite.png"
    web_page_document.setTextContent('<b> test </b><img src="images/favourite.png"/>')
2034 2035 2036 2037
    self.stepTic()
    
    web_page_document_url = '%s/%s' %(self.portal.absolute_url(), web_page_document.getRelativeUrl())
    web_page_image_size, web_page_file_size = self.getURLSizeList(web_page_document_url, **convert_kw)
Ivan Tyagov's avatar
Ivan Tyagov committed
2038
    self.assertTrue(max(preffered_size_for_display) - max(web_page_image_size) <= 1)
2039

Ivan Tyagov's avatar
Ivan Tyagov committed
2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058
    # XXX: how to simulate the case when web page contains (through reference) link to document for which based conversion failed?
    # XXX: how to fix case when web page contains (through reference) link to itself (causes infinite recursion)

    # images from same instance accessed by reference and wrong arguments (dispay NOT display)
    # code should be more resilient
    upload_file = makeFileUpload('cmyk_sample.jpg')
    image = self.portal.image_module.newContent(portal_type='Image',
                                               reference='Embedded-XXX',
                                               version='001',
                                               language='en')
    image.publish()
    convert_kw['quality'] = 99 # to not get cached
    web_page_document = self.portal.web_page_module.newContent(portal_type="Web Page")
    web_page_document.setTextContent('''<b> test </b><img src="Embedded-XXX?format=jpeg&amp;dispay=medium"/>''')
    self.stepTic()
    web_page_document_url = '%s/%s' %(self.portal.absolute_url(), web_page_document.getRelativeUrl())
    web_page_image_size, web_page_file_size = self.getURLSizeList(web_page_document_url, **convert_kw)
    self.assertTrue(max(preffered_size_for_display) - max(web_page_image_size) <= 1)

2059
    # external images
Ivan Tyagov's avatar
Ivan Tyagov committed
2060
    convert_kw['quality'] = 98 # to not get cached
2061 2062 2063 2064 2065 2066 2067 2068 2069 2070
    web_page_document = self.portal.web_page_module.newContent(portal_type="Web Page")
    web_page_document.setTextContent('''<b> test </b><img src="http://www.erp5.com/images/favourite.png"/>
<img style="width: 26px; height: 26px;" src="http://www.erp5.com//images/save2.png" />
''')
    self.stepTic()
    web_page_document_url = '%s/%s' %(self.portal.absolute_url(), web_page_document.getRelativeUrl())
    web_page_image_size, web_page_file_size = self.getURLSizeList(web_page_document_url, **convert_kw)
    self.assertTrue(max(preffered_size_for_display) - max(web_page_image_size) <= 1)


2071 2072 2073 2074 2075
  def test_convertToImageOnTraversal(self):
    """
    Test converting to image all Document portal types on traversal i.e.:
     - image_module/1?quality=100&display=xlarge&format=jpeg
     - document_module/1?quality=100&display=large&format=jpeg
2076 2077
     - document_module/1?quality=10&display=large&format=jpeg
     - document_module/1?display=large&format=jpeg
2078
     - web_page_module/1?quality=100&display=xlarge&format=jpeg
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091
    """
    # Create OOo document
    ooo_document = self.portal.document_module.newContent(portal_type='Presentation')
    upload_file = makeFileUpload('TEST-en-003.odp')
    ooo_document.edit(file=upload_file)

    pdf_document = self.portal.document_module.newContent(portal_type='PDF')
    upload_file = makeFileUpload('TEST-en-002.pdf')
    pdf_document.edit(file=upload_file)

    image_document = self.portal.image_module.newContent(portal_type='Image')
    upload_file = makeFileUpload('TEST-en-002.png')
    image_document.edit(file=upload_file)
2092 2093
    
    web_page_document = self.portal.web_page_module.newContent(portal_type="Web Page")
2094 2095 2096
    web_page_document.setTextContent('<b> test </b> $website_url $website_url')
    # a Web Page can generate dynamic text so test is as well
    web_page_document.setTextContentSubstitutionMappingMethodId('WebPage_getStandardSubstitutionMappingDict')    
2097 2098 2099 2100 2101
    self.stepTic()

    ooo_document_url = '%s/%s' %(self.portal.absolute_url(), ooo_document.getRelativeUrl())
    pdf_document_url = '%s/%s' %(self.portal.absolute_url(), pdf_document.getRelativeUrl())
    image_document_url = '%s/%s' %(self.portal.absolute_url(), image_document.getRelativeUrl())
2102
    web_page_document_url = '%s/%s' %(self.portal.absolute_url(), web_page_document.getRelativeUrl())
2103
   
2104 2105
    for display in ('nano', 'micro', 'thumbnail', 'xsmall', 'small', 'medium', 'large', 'xlarge',):
      max_tollerance_px = 1
2106
      preffered_size_for_display = self.getPreferences(display)
2107 2108 2109 2110 2111 2112 2113 2114
      for format in ('png', 'jpeg', 'gif',):
        convert_kw = {'display':display, \
                      'format':format, \
                      'quality':100}
        # Note: due to some image interpolations it's possssible that we have a difference of max_tollerance_px 
        # so allow some tollerance which is produced by respective portal_transform command

        # any OOo based portal type
2115
        ooo_document_image_size, ooo_document_file_size = self.getURLSizeList(ooo_document_url, **convert_kw)
2116 2117 2118
        self.assertTrue(max(preffered_size_for_display) - max(ooo_document_image_size) <= max_tollerance_px)

        # PDF
2119
        pdf_document_image_size, pdf_document_file_size = self.getURLSizeList(pdf_document_url, **convert_kw)
2120 2121 2122
        self.assertTrue(max(preffered_size_for_display) - max(pdf_document_image_size) <= max_tollerance_px)

        # Image
2123
        image_document_image_size, image_document_file_size = self.getURLSizeList(image_document_url, **convert_kw)
2124
        self.assertTrue(max(preffered_size_for_display) - max(image_document_image_size) <= max_tollerance_px)
2125 2126 2127 2128 2129
        
        # Web Page
        web_page_image_size, web_page_file_size = self.getURLSizeList(web_page_document_url, **convert_kw)
        self.assertTrue(max(preffered_size_for_display) - max(web_page_image_size) <= max_tollerance_px)
        
2130

2131
    # test changing image quality will decrease its file size
2132
    for url in (image_document_url, pdf_document_url, ooo_document_url, web_page_document_url):
2133 2134 2135
      convert_kw = {'display':'xlarge', \
                    'format':'jpeg', \
                    'quality':100}
2136
      image_document_image_size_100p,image_document_file_size_100p = self.getURLSizeList(url, **convert_kw)
2137 2138
      # decrease in quality should decrease its file size
      convert_kw['quality'] = 5.0
2139
      image_document_image_size_5p,image_document_file_size_5p = self.getURLSizeList(url, **convert_kw)
2140 2141
      # removing quality should enable defaults settings which should be reasonable between 5% and 100%
      del convert_kw['quality']
2142
      image_document_image_size_no_quality,image_document_file_size_no_quality = self.getURLSizeList(url, **convert_kw)
2143 2144
      # check file sizes
      self.assertTrue(image_document_file_size_100p > image_document_file_size_no_quality and \
2145 2146 2147 2148 2149 2150 2151
                      image_document_file_size_no_quality > image_document_file_size_5p,
                      "%s should be more then %s and %s should be more them %s" % \
                       (image_document_file_size_100p,
                        image_document_file_size_no_quality,
                        image_document_file_size_no_quality, 
                        image_document_file_size_5p)
                      )
2152 2153
      # no matter of quality image sizes whould be the same
      self.assertTrue(image_document_image_size_100p==image_document_image_size_5p and \
2154 2155 2156 2157 2158 2159 2160
                        image_document_image_size_5p==image_document_image_size_no_quality,
                      "%s should be equals to %s and %s should be equals to %s" % \
                       (image_document_image_size_100p,
                        image_document_image_size_5p,
                        image_document_image_size_5p,
                        image_document_image_size_no_quality)
                      )
2161

2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172
  def test_checkConversionFormatPermission(self):
    """
     Test various use cases when conversion can be not allowed
    """
    portal_type = 'PDF'
    module = self.portal.getDefaultModule(portal_type)
    upload_file = makeFileUpload('TEST.Large.Document.pdf')
    pdf = module.newContent(portal_type=portal_type, file=upload_file)

    # if PDF size is larger than A4 format system should deny conversion
    self.assertRaises(Unauthorized, pdf.convert, format='jpeg')
2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208
  
  def test_preConversionOnly(self):
    """
      Test usage of pre_converted_only argument - i.e. return a conversion only form cache otherwise
      return a default (i.e. indicating a conversion failures)
    """
    doc = self.portal.document_module.newContent(portal_type='Presentation')
    upload_file = makeFileUpload('TEST-en-003.odp')
    doc.edit(file=upload_file)    
    doc.publish()
    self.stepTic()
    
    default_conversion_failure_image_size, default_conversion_failure_image_file_size = \
                            self.getURLSizeList('%s/default_conversion_failure_image' %self.portal.absolute_url())
    
    doc_url = '%s/%s' %(self.portal.absolute_url(), doc.getPath())
    converted_image_size_70, converted_file_size_70 = self.getURLSizeList(doc_url, \
                                                             **{'format':'png', 'quality':70.0})
    self.assertTrue(doc.hasConversion(**{'format': 'png', 'quality': 70.0}))                                                             

    # try with new quality and pre_converted_only now a default image 
    # with content "No image available" should be returned
    failure_image_size, failure_file_size = self.getURLSizeList(doc_url, \
                                                   **{'format':'png', 'quality':80.0, 'pre_converted_only':1})
    self.assertSameSet(failure_image_size, default_conversion_failure_image_size)
    

    converted_image_size_80, converted_file_size_80 = self.getURLSizeList(doc_url, \
                                                             **{'format':'png', 'quality':80.0})
    self.assertSameSet(converted_image_size_80, converted_image_size_70)    
    self.assertTrue(doc.hasConversion(**{'format': 'png', 'quality': 80.0}))
    
    # as conversion is cached we should get it
    converted_image_size_80n, converted_file_size_80n = self.getURLSizeList(doc_url, 
                                                               **{'format':'png', 'quality':80.0, 'pre_converted_only':1})
    self.assertSameSet(converted_image_size_80n, converted_image_size_70)
2209

2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
  def test_getSearchText(self):
    """
     Test extracting search text script.
    """
    request = get_request()
    portal = self.portal

    # test direct passing argument_name_list
    request.set('MySearchableText', 'MySearchableText_value')
    self.assertEqual(request.get('MySearchableText'),
                     portal.Base_getSearchText(argument_name_list=['MySearchableText']))

    # simulate script being called in a listbox
    # to simulate this we set 'global_search_column' a listbox
    form = portal.DocumentModule_viewDocumentList
    listbox = form.listbox
    listbox.manage_edit_surcharged_xmlrpc(dict(
            global_search_column='advanced_search_text'))
    # render listbox
    listbox.render()
    request.set('advanced_search_text', 'advanced_search_text_value')
    self.assertEqual(request.get('advanced_search_text'),
                     portal.Base_getSearchText())

2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276
  def test_Document_getOtherVersionDocumentList(self):
    """
      Test getting list of other documents which have the same reference.
    """
    request = get_request()
    portal = self.portal

    kw={'reference': 'one_that_will_never_change',
        'language': 'en',
         'version': '001'}
    document1 = portal.document_module.newContent(portal_type="Presentation", **kw)
    self.stepTic()
    self.assertEquals(0, len(document1.Document_getOtherVersionDocumentList()))

    kw['version'] == '002'
    document2 = portal.document_module.newContent(portal_type="Spreadsheet", **kw)
    self.stepTic()

    web_page1 = portal.web_page_module.newContent(portal_type="Web Page", \
                                                  **{'reference': 'embedded',
                                                     'version': '001'})
    web_page2 = portal.web_page_module.newContent(portal_type="Web Page", \
                                                 **{'reference': 'embedded',
                                                    'version': '002'})
    self.stepTic()

    # both documents should be in other's document version list
    self.assertSameSet([x.getObject() for x in document1.Document_getOtherVersionDocumentList()], \
                        [document2])
    self.assertSameSet([x.getObject() for x in document2.Document_getOtherVersionDocumentList()], \
                        [document1])
    
    # limit by portal type works
    self.assertSameSet([x.getObject() for x in document1.Document_getOtherVersionDocumentList(**{'portal_type':'Presentation'})], \
                        [])

    # current_web_document mode (i.e. embedded Web Page in Web Section) can override current context
    request.set('current_web_document', web_page1)
    self.assertSameSet([x.getObject() for x in document1.Document_getOtherVersionDocumentList()], \
                        [web_page2])
    request.set('current_web_document', web_page2)
    self.assertSameSet([x.getObject() for x in document1.Document_getOtherVersionDocumentList()], \
                        [web_page1])
2277

2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297
  def test_Base_getWorkflowEventInfoList(self):
    """
      Test getting history of an object.
    """
    portal = self.portal
    document = portal.document_module.newContent(portal_type="Presentation")
    document.edit(title='New')
    document.publish()
    document.reject()
    document.share()
    logged_in_user = str(self.portal.portal_membership.getAuthenticatedMember())
    event_list = document.Base_getWorkflowEventInfoList()
    event_list.reverse()
    # all actions by logged in user
    for event in event_list:
      self.assertEquals(event.actor, logged_in_user)
    self.assertEquals(event_list[0].action, 'Edit')
    self.assertEquals(event_list[-1].action, 'Share Document')
    self.assertEquals(event_list[-2].action, 'Reject Document')
    self.assertEquals(event_list[-3].action, 'Publish Document')
Nicolas Delaby's avatar
Nicolas Delaby committed
2298

2299 2300 2301 2302 2303 2304 2305 2306
  def test_ContributeToExistingDocument(self):
    """
      Test various cases of contributing to an existing document
    """
    request = get_request()
    portal = self.portal
    # contribute a document, then make it not editable and check we can not contribute to it
    upload_file = makeFileUpload('TEST-en-002.doc')
2307
    kw = dict(file=upload_file, synchronous_metadata_discovery=True)
2308
    document = self.portal.Base_contribute(**kw)
2309 2310 2311 2312
    self.stepTic()
    # passing another portal type allows to create a
    # new document, but in draft state.
    # Then User takes a decision to choose which document to publish
2313
    kw['portal_type'] = "Spreadsheet"
2314 2315
    new_document = self.portal.Base_contribute(**kw)
    self.assertEquals(new_document.getValidationState(), 'draft')
Nicolas Delaby's avatar
Nicolas Delaby committed
2316

2317 2318
    # make it read only
    document.manage_permission(Permissions.ModifyPortalContent, [])
2319
    new_document.manage_permission(Permissions.ModifyPortalContent, [])
2320 2321 2322
    self.stepTic()
    kw.pop('portal_type')
    self.assertRaises(Unauthorized, self.portal.Base_contribute, **kw)
Nicolas Delaby's avatar
Nicolas Delaby committed
2323

2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343
  def test_ContributeWithMergingToExistingDocument(self):
    """
      Test various cases of merging to an existing document
    """
    request = get_request()
    portal = self.portal
    # contribute a document, then make it not editable and check we can not contribute to it
    kw=dict(synchronous_metadata_discovery=True)
    upload_file = makeFileUpload('TEST-en-002.doc')
    kw = dict(file=upload_file, synchronous_metadata_discovery=True)
    document = self.portal.Base_contribute(**kw)
    self.stepTic()    
   
    upload_file = makeFileUpload('TEST-en-003.odp', 'TEST-en-002.doc')
    kw = dict(file=upload_file, synchronous_metadata_discovery=True)
    document = self.portal.Base_contribute(**kw)
    self.stepTic()
    self.assertEquals('test-en-003-description', document.getDescription())
    self.assertEquals('test-en-003-title', document.getTitle())
    self.assertEquals('test-en-003-keywords', document.getSubject())
2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361

  def test_DocumentIndexation(self):
    """
      Test how a document is being indexed in MySQL.
    """
    portal = self.portal
    document = portal.document_module.newContent(
                                        portal_type='Presentation', \
                                        reference='XXX-YYY-ZZZZ',
                                        subject_list = ['subject1', 'subject2'])
    self.stepTic()
    # full text indexation
    full_text_result = portal.erp5_sql_connection.manage_test('select * from full_text where uid="%s"' %document.getUid())
    self.assertTrue('subject2' in full_text_result[0]['searchabletext'])
    self.assertTrue('subject1' in full_text_result[0]['searchabletext'])
    self.assertTrue(document.getReference() in full_text_result[0]['searchabletext'])
    
    # subject indexation
2362 2363 2364 2365 2366
    for subject_list in (['subject1',], ['subject2',],
                         ['subject1', 'subject2',],):
      subject_result = portal.portal_catalog(subject=subject_list)
      self.assertEquals(len(subject_result), 1)
      self.assertEquals(subject_result[0].getPath(), document.getPath())
2367

2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412
  def test_base_convertable_behaviour_with_successive_updates(self):
    """Check that update content's document (with setData and setFile)
    will refresh base_data and content_md5 as expected.

    When cloning a document base_data must not be computed once again.
    """
    # create a document
    upload_file = makeFileUpload('TEST-en-002.doc')
    kw = dict(file=upload_file, synchronous_metadata_discovery=True)
    document = self.portal.Base_contribute(**kw)
    self.stepTic()
    previous_md5 = document.getContentMd5()
    previous_base_data = document.getBaseData()

    # Clone document: base_data must not be computed once again
    cloned_document = document.Base_createCloneDocument(batch_mode=True)
    self.assertEquals(previous_md5, cloned_document.getContentMd5())
    self.assertEquals(document.getData(), cloned_document.getData())
    self.assertEquals(document.getBaseData(), cloned_document.getBaseData())
    self.assertEquals(document.getExternalProcessingState(),
                      cloned_document.getExternalProcessingState())
    self.assertEquals(document.getExternalProcessingState(), 'converted')

    # Update document with another content by using setData:
    # base_data must be recomputed
    document.edit(data=makeFileUpload('TEST-en-002.odt').read())
    self.stepTic()
    self.assertTrue(document.hasBaseData())
    self.assertNotEquals(previous_base_data, document.getBaseData(),
                         'base data is not refreshed')
    self.assertNotEquals(previous_md5, document.getContentMd5())
    self.assertEquals(document.getExternalProcessingState(), 'converted')
    previous_md5 = document.getContentMd5()
    previous_base_data = document.getBaseData()

    # Update document with another content by using setFile:
    # base_data must be recomputed
    document.edit(file=makeFileUpload('TEST-en-002.doc'))
    self.stepTic()
    self.assertTrue(document.hasBaseData())
    self.assertNotEquals(previous_base_data, document.getBaseData(),
                         'base data is not refreshed')
    self.assertNotEquals(previous_md5, document.getContentMd5())
    self.assertEquals(document.getExternalProcessingState(), 'converted')

2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432
  # Currently, 'empty' state in processing_status_workflow is only set
  # when creating a document and before uploading any file. Once the
  # document has been uploaded and then the content is cleared, the
  # document state stays at 'converting' state as empty base_data is
  # not handled
  @expectedFailure
  def test_base_convertable_behaviour_when_deleted(self):
    """
    Check that deleting the content of a previously uploaded document
    actually clear base_data and md5 and check that the document goes
    back to empty state
    """
    # create a document
    upload_file = makeFileUpload('TEST-en-002.doc')
    kw = dict(file=upload_file, synchronous_metadata_discovery=True)
    document = self.portal.Base_contribute(**kw)
    self.stepTic()
    self.assertTrue(document.hasBaseData())
    self.assertTrue(document.hasContentMd5())

2433 2434 2435 2436 2437 2438 2439
    # Delete content: base_data must be deleted
    document.edit(data=None)
    self.stepTic()
    self.assertFalse(document.hasBaseData())
    self.assertFalse(document.hasContentMd5())
    self.assertEquals(document.getExternalProcessingState(), 'empty')

2440 2441 2442 2443 2444 2445
  def _test_document_publication_workflow(self, portal_type, transition):
    document = self.getDocumentModule().newContent(portal_type=portal_type)
    self.portal.portal_workflow.doActionFor(document, transition)

  def test_document_publication_workflow_Drawing_publish(self):
    self._test_document_publication_workflow('Drawing', 'publish_action')
2446 2447

  def test_document_publication_workflow_Drawing_publish_alive(self):
2448 2449 2450 2451 2452
    self._test_document_publication_workflow('Drawing',
        'publish_alive_action')

  def test_document_publication_workflow_Drawing_release(self):
    self._test_document_publication_workflow('Drawing', 'release_action')
2453 2454

  def test_document_publication_workflow_Drawing_release_alive(self):
2455 2456 2457 2458 2459
    self._test_document_publication_workflow('Drawing',
        'release_alive_action')

  def test_document_publication_workflow_Drawing_share(self):
    self._test_document_publication_workflow('Drawing', 'share_action')
2460 2461

  def test_document_publication_workflow_Drawing_share_alive(self):
2462 2463 2464 2465 2466
    self._test_document_publication_workflow('Drawing',
        'share_alive_action')

  def test_document_publication_workflow_File_publish(self):
    self._test_document_publication_workflow('File', 'publish_action')
2467 2468

  def test_document_publication_workflow_File_publish_alive(self):
2469 2470 2471 2472 2473
    self._test_document_publication_workflow('File',
        'publish_alive_action')

  def test_document_publication_workflow_File_release(self):
    self._test_document_publication_workflow('File', 'release_action')
2474 2475

  def test_document_publication_workflow_File_release_alive(self):
2476 2477 2478 2479 2480
    self._test_document_publication_workflow('File',
        'release_alive_action')

  def test_document_publication_workflow_File_share(self):
    self._test_document_publication_workflow('File', 'share_action')
2481 2482

  def test_document_publication_workflow_File_share_alive(self):
2483 2484 2485 2486 2487
    self._test_document_publication_workflow('File',
        'share_alive_action')

  def test_document_publication_workflow_PDF_publish(self):
    self._test_document_publication_workflow('PDF', 'publish_action')
2488 2489

  def test_document_publication_workflow_PDF_publish_alive(self):
2490 2491 2492 2493 2494
    self._test_document_publication_workflow('PDF',
        'publish_alive_action')

  def test_document_publication_workflow_PDF_release(self):
    self._test_document_publication_workflow('PDF', 'release_action')
2495 2496

  def test_document_publication_workflow_PDF_release_alive(self):
2497 2498 2499 2500 2501
    self._test_document_publication_workflow('PDF',
        'release_alive_action')

  def test_document_publication_workflow_PDF_share(self):
    self._test_document_publication_workflow('PDF', 'share_action')
2502 2503

  def test_document_publication_workflow_PDF_share_alive(self):
2504 2505 2506 2507 2508
    self._test_document_publication_workflow('PDF',
        'share_alive_action')

  def test_document_publication_workflow_Presentation_publish(self):
    self._test_document_publication_workflow('Presentation', 'publish_action')
2509 2510

  def test_document_publication_workflow_Presentation_publish_alive(self):
2511 2512 2513 2514 2515
    self._test_document_publication_workflow('Presentation',
        'publish_alive_action')

  def test_document_publication_workflow_Presentation_release(self):
    self._test_document_publication_workflow('Presentation', 'release_action')
2516 2517

  def test_document_publication_workflow_Presentation_release_alive(self):
2518 2519 2520 2521 2522
    self._test_document_publication_workflow('Presentation',
        'release_alive_action')

  def test_document_publication_workflow_Presentation_share(self):
    self._test_document_publication_workflow('Presentation', 'share_action')
2523 2524

  def test_document_publication_workflow_Presentation_share_alive(self):
2525 2526 2527 2528 2529
    self._test_document_publication_workflow('Presentation',
        'share_alive_action')

  def test_document_publication_workflow_Spreadsheet_publish(self):
    self._test_document_publication_workflow('Spreadsheet', 'publish_action')
2530 2531

  def test_document_publication_workflow_Spreadsheet_publish_alive(self):
2532 2533 2534 2535 2536
    self._test_document_publication_workflow('Spreadsheet',
        'publish_alive_action')

  def test_document_publication_workflow_Spreadsheet_release(self):
    self._test_document_publication_workflow('Spreadsheet', 'release_action')
2537 2538

  def test_document_publication_workflow_Spreadsheet_release_alive(self):
2539 2540 2541 2542 2543
    self._test_document_publication_workflow('Spreadsheet',
        'release_alive_action')

  def test_document_publication_workflow_Spreadsheet_share(self):
    self._test_document_publication_workflow('Spreadsheet', 'share_action')
2544 2545

  def test_document_publication_workflow_Spreadsheet_share_alive(self):
2546 2547 2548 2549 2550
    self._test_document_publication_workflow('Spreadsheet',
        'share_alive_action')

  def test_document_publication_workflow_Text_publish(self):
    self._test_document_publication_workflow('Text', 'publish_action')
2551 2552

  def test_document_publication_workflow_Text_publish_alive(self):
2553 2554 2555 2556 2557
    self._test_document_publication_workflow('Text',
        'publish_alive_action')

  def test_document_publication_workflow_Text_release(self):
    self._test_document_publication_workflow('Text', 'release_action')
2558 2559

  def test_document_publication_workflow_Text_release_alive(self):
2560 2561 2562 2563 2564
    self._test_document_publication_workflow('Text',
        'release_alive_action')

  def test_document_publication_workflow_Text_share(self):
    self._test_document_publication_workflow('Text', 'share_action')
2565 2566

  def test_document_publication_workflow_Text_share_alive(self):
2567 2568 2569
    self._test_document_publication_workflow('Text',
        'share_alive_action')

2570
class TestDocumentWithSecurity(TestDocumentMixin):
2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582

  username = 'yusei'

  def getTitle(self):
    return "DMS with security"

  def login(self):
    uf = self.getPortal().acl_users
    uf._doAddUser(self.username, '', ['Auditor', 'Author'], [])
    user = uf.getUserById(self.username).__of__(uf)
    newSecurityManager(None, user)

2583
  def test_ShowPreviewAfterSubmitted(self):
2584 2585 2586 2587 2588 2589
    """
    Make sure that uploader can preview document after submitted.
    """
    filename = 'REF-en-001.odt'
    upload_file = makeFileUpload(filename)
    document = self.portal.portal_contributions.newContent(file=upload_file)
Ivan Tyagov's avatar
Ivan Tyagov committed
2590
    self.stepTic()
2591 2592 2593 2594 2595

    document.submit()

    preview_html = document.Document_getPreviewAsHTML().replace('\n', ' ')

Ivan Tyagov's avatar
Ivan Tyagov committed
2596
    self.stepTic()
2597 2598 2599

    self.assert_('I use reference to look up TEST' in preview_html)

2600 2601 2602 2603
  def test_DownloadableDocumentSize(self):
    '''Check that once the document is converted and cached, its size is
    correctly set'''
    portal = self.getPortalObject()
2604 2605
    portal_type = 'Text'
    document_module = portal.getDefaultModule(portal_type)
2606 2607

    # create a text document in document module
2608
    text_document = document_module.newContent(portal_type=portal_type,
2609 2610 2611 2612 2613
                                               reference='Foo_001',
                                               title='Foo_OO1')
    f = makeFileUpload('Foo_001.odt')
    text_document.edit(file=f.read())
    f.close()
Ivan Tyagov's avatar
Ivan Tyagov committed
2614
    self.stepTic()
2615 2616 2617 2618 2619 2620 2621 2622

    # the document should be automatically converted to html
    self.assertEquals(text_document.getExternalProcessingState(), 'converted')

    # check there is nothing in the cache for pdf conversion
    self.assertFalse(text_document.hasConversion(format='pdf'))

    # call pdf conversion, in this way, the result should be cached
2623 2624
    mime_type, pdf_data = text_document.convert(format='pdf')
    pdf_size = len(pdf_data)
2625 2626 2627 2628 2629 2630 2631


    # check there is a cache entry for pdf conversion of this document
    self.assertTrue(text_document.hasConversion(format='pdf'))

    # check the size of the pdf conversion
    self.assertEquals(text_document.getConversionSize(format='pdf'), pdf_size)
2632

2633 2634 2635 2636 2637 2638
  def test_ImageSizePreference(self):
    """
    Tests that when user defines image sizes are already defined in preferences
    those properties are taken into account when the user
    views an image
    """
2639
    super(TestDocumentWithSecurity, self).login('yusei')
2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657
    preference_tool = self.portal.portal_preferences
    #get the thumbnail sizes defined by default on default site preference
    default_thumbnail_image_height = \
       preference_tool.default_site_preference.getPreferredThumbnailImageHeight()
    default_thumbnail_image_width = \
       preference_tool.default_site_preference.getPreferredThumbnailImageWidth()
    self.assertTrue(default_thumbnail_image_height > 0)
    self.assertTrue(default_thumbnail_image_width > 0)    
    self.assertEqual(default_thumbnail_image_height,
                     preference_tool.getPreferredThumbnailImageHeight())
    self.assertEqual(default_thumbnail_image_width,
                     preference_tool.getPreferredThumbnailImageWidth())
    #create new user preference and set new sizes for image thumbnail display 
    user_pref = preference_tool.newContent(
                          portal_type='Preference',
                          priority=Priority.USER)
    self.portal.portal_workflow.doActionFor(user_pref, 'enable_action')
    self.assertEqual(user_pref.getPreferenceState(), 'enabled')
Ivan Tyagov's avatar
Ivan Tyagov committed
2658
    self.stepTic()
2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672
    user_pref.setPreferredThumbnailImageHeight(default_thumbnail_image_height + 10)
    user_pref.setPreferredThumbnailImageWidth(default_thumbnail_image_width + 10)
    #Verify that the new values defined are the ones used by default
    self.assertEqual(default_thumbnail_image_height + 10,
                     preference_tool.getPreferredThumbnailImageHeight())
    self.assertEqual(default_thumbnail_image_height + 10,
                     preference_tool.getPreferredThumbnailImageHeight(0))
    self.assertEqual(default_thumbnail_image_width + 10,
                     preference_tool.getPreferredThumbnailImageWidth())
    self.assertEqual(default_thumbnail_image_width + 10,
                     preference_tool.getPreferredThumbnailImageWidth(0))
    #Now lets check that when we try to view an image as thumbnail, 
    #the sizes of that image are the ones defined in user preference
    image_portal_type = 'Image'
2673 2674
    image_module = self.portal.getDefaultModule(image_portal_type)
    image = image_module.newContent(portal_type=image_portal_type)
2675
    self.assertEqual('thumbnail',
2676
       image.Image_view._getOb('my_thumbnail', None).get_value('image_display'))
2677 2678 2679
    self.assertEqual((user_pref.getPreferredThumbnailImageWidth(),
                    user_pref.getPreferredThumbnailImageHeight()),
                     image.getSizeFromImageDisplay('thumbnail'))
2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698

class TestDocumentPerformance(TestDocumentMixin):

  def test_01_LargeOOoDocumentToImageConversion(self):
    """
      Test large OOoDocument to image conversion
    """
    ooo_document = self.portal.document_module.newContent(portal_type='Spreadsheet')
    upload_file = makeFileUpload('import_big_spreadsheet.ods')
    ooo_document.edit(file=upload_file)
    self.stepTic()
    before = time.time()
    # converting any OOoDocument -> PDF -> Image
    # make sure that this can happen in less tan XXX seconds i.e. code doing convert
    # uses only first PDF frame (not entire PDF) to make an image - i.e.optimized enough to not kill 
    # entire system performance by doing extensive calculations over entire PDF (see r37102-37103)
    ooo_document.convert(format='png')
    after = time.time()
    req_time = (after - before)
2699 2700 2701 2702 2703
    # we should have image converted in less than Xs
    # the 100s value is estimated one, it's equal to time for cloudood conversion (around 52s) +
    # time for gs conversion. As normally test are executed in parallel some tollerance is needed.
    self.assertTrue(req_time < 100.0, 
      "Conversion took %s seconds and it is not less them 100.0 seconds" % \
2704
        req_time)
Ivan Tyagov's avatar
Ivan Tyagov committed
2705

2706 2707 2708
def test_suite():
  suite = unittest.TestSuite()
  suite.addTest(unittest.makeSuite(TestDocument))
2709 2710
  #suite.addTest(unittest.makeSuite(TestDocumentWithSecurity))
  #suite.addTest(unittest.makeSuite(TestDocumentPerformance))
2711
  return suite
Bartek Górny's avatar
Bartek Górny committed
2712 2713


Fabien Morin's avatar
Fabien Morin committed
2714
# vim: syntax=python shiftwidth=2