alfresco-community-repo/source/java/org/alfresco/repo/content/AbstractWritableContentStoreTest.java
Dave Ward 10da961097 Merged V3.3-BUG-FIX to HEAD
21981: Fixed ALF-2390: ContentService needs to return total/available space values where possible
      - Added ContentService getStoreTotalSpace and getStoreFreeSpace
      - Supported by underlying ContentStore methods
         - getSpaceUsed: Actual binary storage size (was getTotalSize, which is not deprecated)
         - getSpaceTotal: Total storage space on partition
         - getSpaceAvailable: Remaining storage space on partition
      - Added JMX methods
      - Note: getSpaceUsed is NOT exposed as a service method as it is too easy to abuse
   21982: Follow-up to Fixed ALF-2390: Patch uses new 'getSizeUsed' instead of deprecated 'getTotalSize'
   21983: Fixed ALF-766: Allow cache peer URLs to be set in ehcache-custom.xml
      - Was investigating settings required for client, so just added this in
      - By default, the 'cacheManagerPeerListenerFactory' uses no system properties, but
        a comment has been added on how to define hostName, port and socketTimeoutMillis.
      - Variables associated with that have been added to repository.properties and are
        exported to the Java system properties environment for EHCache to pick up.
   21984: More ALF-766: Allow cache peer URLs to be set in ehcache-custom.xml
      - Added alfresco.ehcache.rmi.remoteObjectPort (see ALF-765)
   22011: Fix for ALF-3005 - Blog and Discussion components not correctly checking length of modified HTML content
   22074: Fix for ALF-4447 - Failure when publishing a Post - some reverse proxies changing the response header to lower case
   22075: (RECORD ONLY) Merged HEAD to BRANCHES/DEV/V3.3-BUG-FIX:
      22073: Resolve ALF-4522: Accessing document via /alfresco/service/api/path doesn't work - "Company Home" token is duplicated
   22091: Merged PATCHES/V2.2.7 to V3.3-BUG-FIX (RECORD ONLY)
      19832: Merged BRANCHES/V3.1 to PATCHES/V2.2.7:
         17255: Fixed ETHREEOH-3180: Error appears when trying to search resources on Manage Task page
      19778: Incremented version label
      19769: ALF-2011: Backported dependencies
         ALF-2360: Merged V3.1 to PATCHES/V2.2.7
            17314: ETHREEOH-3158: Fix RepoServerMgmt to work with external authentication methods
               - AuthenticationService.getCurrentTicket / getNewTicket now call pre authentication check before issuing a new ticket, thus still allowing ticket enforcement when external authentication is in use.
         ALF-2361: Merged V3.2 to PATCHES/V2.2.7
            17456: Fix for: ETHREEOH-1465: It's impossible to get the login history for a given user (Audit)
               - all authentication routes (SSO and password) can now audit getting a new ticket for a session. SSO does not authenticate via the alfresco AuthenticationService API
               - you can now use auditing to track new sessions for users.
      19558: Created hotfix branch off TAGS/ENTERPRISE/V2.2.7
      19557: Tagged V2.2 build 533 Revision 19303 as TAGS/ENTERPRISE/V2.2.7
   22092: Merged PATCHES/V3.1.0 to V3.3-BUG-FIX (RECORD ONLY)
      21274: Merged PATCHES/V3.1.2 to PATCHES/V3.1.0
         21264: ALF-3889: JBPMDeployProcessServlet not accessible by default
            - Should only be enabled in development environment
      20242: ALF-2733: Recreate corrupt authorities produced by LDAP import
      20240: ALF-2733: Recreate corrupt authorities produced by LDAP import
      19032: Moved V3.1.0-ENTERPRISE-FINAL into ENTERPRISE/V3.1.0
      13776: Tagged V3.1 rev 13700 (build 142) as V3.1.0-ENTERPRISE-FINAL
   22093: Merged PATCHES/V3.1.1 to V3.3-BUG-FIX (RECORD ONLY)
      21570: ALF-3687: Build classpath fix
      21549: Merged PATCHES/V3.1.0 to PATCHES/V3.1.1
         20221: Merged PATCHES/V3.1.2 to PATCHES/V3.1.0
            20217: Merged PATCHES/V3.2.0 to PATCHES/V3.1.2
               19793: Merged HEAD to V3.2.0
                  19786: Refactor of previous test fix. I have pushed down the OOo-specific parts of the change from AbstractContentTransformerTest to OpenOfficeContentTransformerTest leaving an extension point in the base class should other transformations need to be excluded in the future.
                  19785: Fix for failing test OpenOfficeContentTransformerTest.testAllConversions.
                     Various OOo-related transformations are returned as available but fail on our test server with OOo on it.
                     Pending further work on these failings, I am disabling those transformations in test code whilst leaving them available in the product code. This is because in the wild a different OOo version may succeed with these transformations.
                     I had previously explicitly disabled 3 transformations in the product and I am moving that restriction from product to test code for the same reason.
                  19707: Return value from isTransformationBlocked was inverted. Fixed now.
                  19705: Refinement of previous check-in re OOo transformations.
                     I have pulled up the code that handles blocked transformations into a superclass so that the JodConverter-based transformer worker can inherit the same list of blocked transformations. To reiterate, blocked transformations are those that the OOo integration code believes should work but which are broken in practice. These are blocked by the transformers and will always be unavailable regardless of the OOo connection state.
                  19702: Fix for HEAD builds running on panda build server.
                     OOo was recently installed on panda which has activated various OOo-related transformations/extractions in the test code.
                     It appears that OOo does not support some transformations from Office 97 to Office 2007. Specifically doc to docx and xls to xlsx. These transformations have now been marked as unavailable.
      21548: Incremented version label
      21547: ALF-4121: Merged V3.2 to PATCHES/V3.1.1
         16827: ETHREEOH-2678 - Unfriendly system error occurs when trying to view Workflows information on content Details page if workflow was canceled
      21275: Merged PATCHES/V3.1.2 to PATCHES/V3.1.1
         21264: ALF-3889: JBPMDeployProcessServlet not accessible by default
            - Should only be enabled in development environment
      21235: Removed old source zip
      21233: Merged PATCHES/V3.1.2 to PATCHES/V3.1.1
         20890: ALF-3687: Apply LUCENE-1383 patch to Lucene 2.1.0 to reduce memory leaks from ThreadLocals
         20891: ALF-3687: Build classpath fix
      21227: Merged PATCHES/V3.2.1 to PATCHES/V3.1.1
         21207: Extra debug logging to track index triggering activity
      21225: Merged V3.2 to PATCHES/V3.1.1
         19598: Backported (merge not possible) HEAD rev 18790 for IndexInfo fixes
            - Hit problem where re-index threads were all waiting for merging, which had nothing to do
      21223: Merged V3.2 to PATCHES/V3.1.1
         16923: Lucene performance: avoid too many index deltas getting created by throttling transactions when the number of index entries gets above a configurable size
            - Stops performance degradation over time and out of memory errors under load
      21222: Merged V3.2 to PATCHES/V3.1.1
         16799: Fix for ETHREEOH-2843:  lucene.indexer.minMergeDocs , lucene.indexer.mergeFactor and lucene.indexer.maxMergeDocs are never read / used
            - removed unused properties and parameterised the remaining unexposed properties
      21220: Created hotfix branch off TAGS/ENTERPRISE/V3.1.1
      19033: Moved V3.1.1-ENTERPRISE-FINAL into ENTERPRISE/V3.1.1
      14897: Tagged V3.1 rev 14748 (build 229) as TAGS/V3.1.1-ENTERPRISE-FINAL
   22096: Merged PATCHES/V3.1.2 to V3.3-BUG-FIX (RECORD ONLY)
      22033: ALF-4504: Fix unit test classpath
      22031: ALF-4503: Removed spurious mergeinfo
      22030: ALF-4503: Merged V3.2 to PATCHES/V3.1.2
         19518: ALF-757: Corrected audit config resource URL so that it resolves inside Tomcat as well as JUnit!
      22028: Incremented version label
      22026: ALF-4504: Merged HEAD to PATCHES/V3.1.2
         19958: Updating pdfbox and fontbox libraries.
            The 3rd party libraries apache pdfbox and apache fontbox have been updated from version 0.8.0-incubating to version 1.1.0.

            Apache states that: [...] notable changes in this release include basic support for tagged PDF, various font handling improvements and better handling of CJK character sets.

            Source is available as before for pdfbox, but is no longer included for fontbox.
      22025: ALF-4503: Merged V3.2 to PATCHES/V3.1.2
         18000: Merged DEV/BELARUS/V3.2-2009_11_24 to V3.2
            17719: ETHREEOH-3393: AuditConfig file is read every time the audit method is called in HibernateAuditDAO
         19501: Merged DEV/BELARUS/V3.2-2010_02_24 to HEAD (with corrections)
            19243: ALF-757: Cannot start up on JBoss 5.1 due to audit configuration error
               - Removed getPath() method because it is incompatible with JBoss and other app servers where resources can't be resolved to a file
               - Now use Spring ResourceLoader instead of creating FileInputStream
               - getLastModified() still returned where the resource resolves to a file; otherwise the server startup time
      21699: Incremented version label
      21697: ALF-4275: Merged PATCHES/V3.2.0 to PATCHES/V3.1.2
         20349: Merged V3.3 to PATCHES/V3.2.0
            20346: ALF-2839: Node pre-loading generates needless resultset rows
               - Added missing Criteria.list() call
         20280: Fixed ALF-2839: Node pre-loading generates needless resultset rows
              - Split Criteria query to retrieve properties and aspects separately
      21696: ALF-4275: Merged V3.3-BUG-FIX to PATCHES/V3.1.2
         20231: Fixed ALF-2784: Degradation of performance between 3.1.1 and 3.2x (observed in JSF)
            - Handles warm caches more efficiently
            - Doesn't regress on ETWOTWO-949
            - Can be backported safely
      21694: ALF-4275: Merged PATCHES/V3.2.0 to PATCHES/V3.1.2
         20266: Test reproduction of ALF-2839 failure: Node pre-loading generates needless resultset rows
      17041: Merged V3.2 to V3.1
         17023: Fixed parentAssocCache bug when adding assocs against an empty cache   
      16987: Merge 2.2 to 3.1:
         13089: (record-only) Fix "Read-Write transaction" exception, when the user does not exist. ETWOTWO-1055.
         13091: (record-only) Fix for NFS server "Read-Write transaction started within read-only transaction" exception. ETWOTWO-1054.
         14190: (record-only) Fix for cut/paste a folder from Alfresco CIFS to local drive loses folder contents. ETWOTWO-1159.
         14191: (record-only) Additional fix for CIFS 'No more connections' error. ETWOTWO-556
         14199: (record-only) Fix for NFS problem with Solaris doing an Access check on the share level handle. ETWOTWO-1225.
         14210: (record-only) Added support for FTP EPRT and EPSV commands, on IPv4 only. ETWOTWO-325.
         14216: (record-only) Fixed FTP character encoding, ported UTF8 normalizer code from v3.x. ETWOTWO-1151.
         14229: (record-only) Remove unused import.
         14655: (record-only) Convert content I/O exceptions to file server exceptions during write and truncate. ETWOTWO-1241.
         14825: (record-only) Add support for the extended response to the CIFS NTCreateAndX call, back port of ETWOTWO-1232.
         15869: (record-only) Port of desktop action client side EXE fixes from v3.x. ETWOTWO-1374.
      16727: Fix for unable to connect via FTP via Firefox (when anonymous logons are not enabled). ETHREEOH-2012.
      16718: Fix for Alfresco and AVM spaces are empty when viewed by FTP and Alfresco is run as non-root. ETHREEOH-2652.
         Triggered when CIFS server uses default ports on Linux/Unix/Mac platforms and fails to start.
      16717: Fixed setAllowConsoleShutdown setting in standalone server can cause infinite loop. JLAN-38.
      16710: Added CIFS NT status code/text for the 'account locked' status, 0xC0000234. ETHREEOH-2897.
      16709: Fixed the FTP not logged on status return code, now uses reply code 530. JLAN-90.
      16666: Fix for CIFS cannot handle requests over 64K in JNI code, causes session disconnect, standalone server. JLAN-91.
      16559: Fix for ACL parsing in the standalone JLAN Server build. JLAN-89.
      16556: Fix for CIFS session leak and 100% CPU when connect/disconnecting quickly. ETHREEOH-2881. 
      16555: Fix for processing of NetBIOS packets over 64K in the older JNI code. Part of ETHREEOH-2882.
      16309: Merged V2.2 to V3.1 (for rev 16305)
         16304: Fix ETWOONE-335: Parallel Review does not store Priority and Due Date set at task creation
      16305: ETWOONE-335: Parallel Review does not store Priority and Due Date set at task creation
      16163: Added timstamp tracking via the file state cache, blend cached timestamps into file info/folder search results.
         Added support for . and .. pseudo entries in a wildcard folder search.
      16162: Add support for the . and .. pseudo entries in a folder search.
         Return EA size as zero in CIFS file information levels.
         Added more debug output to notify change handler.
      16160: Minor change to debug output
      15827: Fixed bug in delete node event processing.
      15780: Fix for MS Office document locking issue. ETHREEOH-2579.
      15628: Update svn:mergeinfo
      15627: Merge 3.2 to 3.1:
         15626: Fixed NetBIOS reports an invalid packet during session connection, and connection stalls for a while. JLAN-86.
      15572: Update svn:mergeinfo
      15571: Merge 3.2 to 3.1:
         15549: Check for null ClientInfo in the setCurrentUser() method and clear the auth context. Part of ETHREEOH-2538.
         15550: Fixed performance issue in the continue search code, add warn level output of folder search timing.
      15570: Merge 3.2 to 3.1:
         15548: CIFS server memory leak fixes (clear auth context, session close). ETHREEOH-2538
      15231: Fix for cut/paste file between folders on CIFS. ETHREEOH-2323.
         Added debug flags to the Alfresco filesystems, implemented in the ContentDiskDriver. Changed debug output to be single line. ENH-515.
      14930: Updated svn:mergeinfo
      14921: Merge HEAD to V3.1:
         14599: Fixes to file server ACL parsing, part of ETHREEOH-2177
      14916: Fixes for local domain lookup when WINS is configured. ETHREEOH-2263.
      14523: Add trailing 'A' to CIFS server name, removed by recent checkin.
      14484: Merged HEAD to v3.1:
         13943 Added FTP IPv6 configuration, via the <IPv6 state="enabled|disabled"/> tag. Added the ftp.ipv6 property. MOB-714.
      14483: Merged HEAD to v3.1:
         13942 Added FTP IPv6 support. MOB-714.
   22097: Merged PATCHES/V3.2.0 to V3.3-BUG-FIX (RECORD ONLY)
      21556: Incremented version label
      21555: ALF-4208: Merged PATCHES/V3.1.1 to PATCHES/V3.2.0
         21225: Merged V3.2 to PATCHES/V3.1.1
            19598: Backported (merge not possible) HEAD rev 18790 for IndexInfo fixes
               - Hit problem where re-index threads were all waiting for merging, which had nothing to do
      17875: “Tagged V3.2 build 304 Revision 17823 as TAGS/V3.2.0-ENTERPRISE-FINAL”
   22098: Merged PATCHES/V3.2.1 to V3.3-BUG-FIX (RECORD ONLY)
      17876: Fix CMIS repo and folder browser web scripts. This can now be used as sample stand-alone JSR-168 portlet.
      18309: ETHREEOH-4003: Impossibility to declare email as record
      18378: ETHREEOH-4034: Permission exception when creating non-electronic records ...
      18468: ETHREEOH-4105: Frozen Records Can Be Destroyed
      18470: Part of ETHREEOH-4089: StoreModelObjectPersister fails to load model object
         - Added toString() methods to aid with diagnostics
      18471: Fixed ETHREEOH-4089: StoreModelObjectPersister fails to load model object
         - If the XML fails to parse, then it is treated the same as a missing document.
         - Rather than having the system fail, the XML failures are reported (turn DEBUG
           on for full XML dump) and the document is treated the same as
           "store.hasDocument() = false"
         - Merges to HEAD will need merging to SpringFramework
      18494: ETHREEOH-4089: StoreModelObjectPersister fails to load model object
         - Handle document parsing exceptions as well
      19170: Fixed ALF-730: MLText is not fully carried during cut-paste or copy-paste
         - Fetching of properties for copy now uses 'mlAwareNodeService'
      19286: Fix for https://issues.alfresco.com/jira/browse/ALF-626 "Using 'null' as an authority argument in clearPermissions() cause a java.lang.NullPointerException"
      19406: Fix for ALF-649 - Web Service query() no longer returns metadata in 3.2
      19597: Gave PropertyBackedBeanExporter a shorter name for it's cluster region name
      19599: Fix ETHREEOH-2583: Make the index tracking "hole" retention period more configurable
         - Added property 'index.tracking.maxVoidRetentionTimeMinutes', which defaults to the 'maxTxnDurationMinutes'
         - Even more usefully, added 'index.tracking.minVoidCheckPeriodSeconds' that allows void checking to be less frequent
           defaulting to only doing it every 60s
         - Added explicit logging for voids: log4j.logger.org.alfresco.repo.node.index.IndexTransactionTracker.voids=DEBUG
      19654: Fix blog test
      19718: Merged HEAD to BRANCHES/V3.2:
         19678: Fix PostgreSQL handling for null Serializable values (ALF-1614)
            - Provides generic way of targeting BLOB behaviour for different dialects
            - Fixes ALF-2301 by the way
      19759: Fix for CIFS/CheckInOut.exe save of working copy breaks lock on original file. ALF-2028.
      19760: Fix for working copy checked out via CIFS is not accessible until FileStateReaper expires file state. ALF-962.
      20048: "Tagged V3.2 build 499 Revision 19935 as TAGS/ENTERPRISE.V3.2.1"
      21166: Merged V3.3-BUG-FIX to PATCHES/V3.2.1
         21165: Fixed ALF-3867: SQL format error when re-instating orphaned content URL
            - Parameter was not bounded with #
            - Added unit test to ensure SQL generated is correct
   22101: Resolve ALF-4522: Accessing document via /alfresco/service/api/path doesn't work - "Company Home" token is duplicated
   - /cmis... urls accept paths relative to CMIS root path (which is /Company Home)
   - /api/path... urls accept paths relative to root of store
   22103: Merge from HEAD to V3.3-BUG-FIX
      22099: Fix for ALF-3733.

      Note that this should also fix ALF-4465.
   22104: Merged V3.3 to V3.3-BUG-FIX
      21690: ALF-3991: Disable audit behaviour when applying the RenditionModel.ASPECT_RENDITIONED aspect
      21722: Merged PATCHES/V3.3.1 to V3.3
         21721: ALF-4039: Extend store name encoding to all non-ASCII characters, as otherwise these are incorrectly mangled by the Tomcat 5 virtualization server when they appear in a web app path
            - Also use -x instead of _x so that the full encoded user name can be included in a DNS name
            - WCM preview now working with variety of user sandboxes with exotic characters in the user name!
      21767: ALF-4234: CMIS Relationships (fix issue with source and target relationship type checking)
      21789: ALF-4333: Fix
         - Updated RepoPrimaryManifestProcessorImpl so it can handle deletions that are reported by either pre-delete noderef or archived noderef (previously only handled the latter).
         - Updated TransferManifestNodeFactory so that it handles the case where the status of the node to transfer is "deleted".
         - Updated UnitTestTransferManifestNodeFactory so that it handles the change to TransferManifestNodeFactory above.
         - Added new tests for deletion cases.
      21808: Fix for ALF-1908 - encoding for all arguments to all templates associated with WebScripts that can be exposed and executed via a URL.
         - this includes any freemarker templates in /components and /modules that can be executed via url and do not touch context objects that would cause them to be invalid when executed via that url, for example any component or template that touches page.* cannot be executed via a url in the browser, but those that do not *could* be exposed via a clever scripted URL and be manipulated to potentially contain XSS code.
      21837: ALF-4039: In WebProjectServiceImpl.getWebUserRef() do not trust results of Lucene search alone. Certain special characters are ignored or treated as equivalent. Do string comparison to ensure exact match.
      21843: Merged V3.3-BUG-FIX to V3.3
         21137: ALF-3841: Alfresco Explorer SSO Authentication Filters now accept ticket parameters too
            - Can be turned back off with ntlm.authentication.browser.ticketLogons=false or kerberos.authentication.browser.ticketLogons=false
            - Wiki updated
      21856: ALF-4391: Fix Share URL rewrite configuration
         - The URL rewrite configuration was not including the query string in the source URL meaning that it got lost in the rewritten URL (for some reason only on Websphere)
         - Solved this by using the urlrewrite.xml from ALF-260 and adding use-query-string="true"
         - Need to retest on Tomcat and WAS
      21873: Fix ALF-2974: Locate file action is absent for documents in I'm editing tab in Repository
      21907: ALF-4401: Web services not working on Websphere 7 (ever?)
         - Added in Sun SAAJ and JAXP reference implementations to shared library in order to make CXF work
         - Removed old Sun SAAJ libraries as these are embedded into JDK 1.6
      21911: ALF-4399: Broken Repository Document library in Share on Websphere.
         (Fixing fallout from argument encoding in r21808)
      21924: Further fixes for ALF-1908 - XSS argument encoding fixes in Forms runtime
      21987: ALF-4187: Fix bitrock installer config so that the RMI communication ports are randomly selected and do not clash with the RMI registry port
      21998: ALF-4323: Fix ability to use ECMA-357 ECMAScript for XML (E4X) expressions in Share on Weblogic (and Rules Management)
         - Use child first loading of org.apache.xmlbeans.* packages
         - Makes sense because it was originally donated by BEA
   22105: Merged PATCHES/V3.2.r to V3.3-BUG-FIX (RECORD ONLY)
      21082: Fixes for ALF-3777 and ALF-3778 - improvements to XSS attack mitigation.
      21375: Fix ALF-3951 - XSS attack mitigation for IE6 browser. Also minor wiki code formatting fixes & HTML entities appearing in wiki dashlet.
      21400: Merged BRANCHES/V3.2 to PATCHES/V3.2.r
         19144: Added PRE tag to whitelist of safe tags for HTML stripping in Share.
         19363: Fix for ALF-1952 - multi-pass HTML stripping
         19814: Fix for ALF-2322 - discussion topic containing non-ascii characters cannot be saved
      21759: Fix for IE6 XSS issue ALF-4307
   22106: Merged PATCHES/V3.3.1 to V3.3-BUG-FIX (RECORD ONLY)
      21838: Merged V3.3 to PATCHES/V3.3.1
         21837: ALF-4039: In WebProjectServiceImpl.getWebUserRef() do not trust results of Lucene search alone. Certain special characters are ignored or treated as equivalent. Do string comparison to ensure exact match.
      21941: ALF-4424: Merged V3.3-BUG-FIX to PATCHES/V3.3.1
         21659: Workaround for ALF-4230: use of flash technology to upload documents into a share site makes the use of (some) external authentication methods difficult (or impossible)
            - The Flash uploader can be disabled via share-config: DocumentLibary / file-upload / adobe-flash-enabled
      21944: Incremented version label
      22079: ALF-4458: Merged PATCHES/V3.2.1 to PATCHES/V3.3.1
         21606 ALF-4044: Introduced new policy.content.update.ignoreEmpty setting, that when true causes the repository to behave as it did before the fix to ALF-254. I.e. writing empty content will not trigger onContentPropertyUpdate policies or inbound content rules. This enables better compatibility with mac clients using CIFS or WebDAV; they actually create and close a file before appending its data.
      ALF-4458: Merged V3.3 to PATCHES/V3.3.1
         20855: Fix for ALF-3690. Unable to FTP files into Share site documentLibrary folder.
            This fix corrects what it essentially a typo. The dictionaryService was injected twice into the CreateNodeRuleTrigger bean, rather than the dictionaryService and the ruleService.
      22082: Incremented version label
   22107: Merged PATCHES/V3.3.1 to V3.3-BUG-FIX
      21943: ALF-4402: Use normalized repository user ID when doing filesystem quota tracking
      22080: ALF-4458: Fixed broken logic in CreateNodeRuleTrigger.onAddAspect()
         - hasAspect() check was inverted because onAddAspect() is called before aspect is actually added


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@22108 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2010-08-31 19:35:11 +00:00

780 lines
29 KiB
Java

/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.content;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.channels.ReadableByteChannel;
import java.util.Date;
import java.util.Locale;
import org.alfresco.repo.content.ContentStore.ContentUrlHandler;
import org.alfresco.service.cmr.repository.ContentIOException;
import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.cmr.repository.ContentStreamListener;
import org.alfresco.service.cmr.repository.ContentWriter;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Abstract base class that provides a set of tests for implementations
* of {@link ContentStore}.
*
* @see ContentStore
* @see org.alfresco.service.cmr.repository.ContentReader
* @see org.alfresco.service.cmr.repository.ContentWriter
*
* @author Derek Hulley
*/
public abstract class AbstractWritableContentStoreTest extends AbstractReadOnlyContentStoreTest
{
private static Log logger = LogFactory.getLog(AbstractWritableContentStoreTest.class);
public AbstractWritableContentStoreTest()
{
super();
}
/**
* {@inheritDoc}
* <p>
* This implementation creates some content in the store and returns the new content URL.
*/
protected String getExistingContentUrl()
{
ContentWriter writer = getWriter();
writer.putContent("Content for " + getName());
return writer.getContentUrl();
}
/**
* Get a writer into the store. This test class assumes that the store is writable and
* that it therefore supports the ability to write content.
*
* @return
* Returns a writer for new content
*/
protected ContentWriter getWriter()
{
ContentStore store = getStore();
return store.getWriter(ContentStore.NEW_CONTENT_CONTEXT);
}
public void testSetUp() throws Exception
{
// check that the store remains the same
ContentStore store = getStore();
assertNotNull("No store provided", store);
assertTrue("The same instance of the store must be returned for getStore", store == getStore());
}
public void testWritable() throws Exception
{
ContentStore store = getStore();
assertTrue("The store cannot be read-only", store.isWriteSupported());
}
/**
* Just check that the method doesn't blow up
*/
public void testSpaceUsed() throws Exception
{
ContentStore store = getStore();
store.getSpaceUsed();
}
/**
* Just checks that the method doesn't blow up
*/
public void testSpaceFree() throws Exception
{
ContentStore store = getStore();
store.getSpaceFree();
}
/**
* Just checks that the method doesn't blow up
*/
public void testSpaceTotal() throws Exception
{
ContentStore store = getStore();
store.getSpaceTotal();
}
/**
* Just check that the method doesn't blow up
*/
public void testRootLocation() throws Exception
{
ContentStore store = getStore();
String rootLocation = store.getRootLocation();
assertNotNull("The root location may not be null", rootLocation);
}
/**
* Helper to ensure that illegal content URLs are flagged for <b>getWriter</b> requests
*/
private void checkIllegalWritableContentUrl(ContentStore store, String contentUrl)
{
assertFalse("This check is for unsupported content URLs only", store.isContentUrlSupported(contentUrl));
ContentContext bogusContentCtx = new ContentContext(null, contentUrl);
try
{
store.getWriter(bogusContentCtx);
fail("Expected UnsupportedContentUrlException, but got nothing");
}
catch (UnsupportedContentUrlException e)
{
// Expected
}
}
/**
* Checks that the error handling for <i>inappropriate</i> content URLs
*/
public void testIllegalWritableContentUrls()
{
ContentStore store = getStore();
checkIllegalWritableContentUrl(store, "://bogus");
checkIllegalWritableContentUrl(store, "bogus://");
checkIllegalWritableContentUrl(store, "bogus://bogus");
}
/**
* Get a writer and write a little bit of content before reading it.
*/
public void testSimpleUse()
{
ContentStore store = getStore();
String content = "Content for " + getName();
ContentWriter writer = store.getWriter(ContentStore.NEW_CONTENT_CONTEXT);
assertNotNull("Writer may not be null", writer);
// Ensure that the URL is available
String contentUrlBefore = writer.getContentUrl();
assertNotNull("Content URL may not be null for unused writer", contentUrlBefore);
assertTrue("URL is not valid: " + contentUrlBefore, AbstractContentStore.isValidContentUrl(contentUrlBefore));
// Write something
writer.putContent(content);
String contentUrlAfter = writer.getContentUrl();
assertTrue("URL is not valid: " + contentUrlBefore, AbstractContentStore.isValidContentUrl(contentUrlAfter));
assertEquals("The content URL may not change just because the writer has put content", contentUrlBefore, contentUrlAfter);
// Get the readers
ContentReader reader = store.getReader(contentUrlBefore);
assertNotNull("Reader from store is null", reader);
assertEquals(reader.getContentUrl(), writer.getContentUrl());
String checkContent = reader.getContentString();
assertEquals("Content is different", content, checkContent);
}
/**
* Checks that the various methods of obtaining a reader are supported.
*/
public void testGetReader() throws Exception
{
ContentStore store = getStore();
ContentWriter writer = store.getWriter(ContentStore.NEW_CONTENT_CONTEXT);
String contentUrl = writer.getContentUrl();
// Check that a reader is available from the store
ContentReader readerFromStoreBeforeWrite = store.getReader(contentUrl);
assertNotNull("A reader must always be available from the store", readerFromStoreBeforeWrite);
// check that a reader is available from the writer
ContentReader readerFromWriterBeforeWrite = writer.getReader();
assertNotNull("A reader must always be available from the writer", readerFromWriterBeforeWrite);
String content = "Content for " + getName();
// write some content
long before = System.currentTimeMillis();
writer.setMimetype("text/plain");
writer.setEncoding("UTF-8");
writer.setLocale(Locale.CHINESE);
writer.putContent(content);
long after = System.currentTimeMillis();
// get a reader from the store
ContentReader readerFromStore = store.getReader(contentUrl);
assertNotNull(readerFromStore);
assertTrue(readerFromStore.exists());
// Store-provided readers don't have context other than URLs
// assertEquals(writer.getContentData(), readerFromStore.getContentData());
assertEquals(content, readerFromStore.getContentString());
// get a reader from the writer
ContentReader readerFromWriter = writer.getReader();
assertNotNull(readerFromWriter);
assertTrue(readerFromWriter.exists());
assertEquals(writer.getContentData(), readerFromWriter.getContentData());
assertEquals(content, readerFromWriter.getContentString());
// get another reader from the reader
ContentReader readerFromReader = readerFromWriter.getReader();
assertNotNull(readerFromReader);
assertTrue(readerFromReader.exists());
assertEquals(writer.getContentData(), readerFromReader.getContentData());
assertEquals(content, readerFromReader.getContentString());
// check that the length is correct
int length = content.getBytes(writer.getEncoding()).length;
assertEquals("Reader content length is incorrect", length, readerFromWriter.getSize());
// check that the last modified time is correct
long modifiedTimeCheck = readerFromWriter.getLastModified();
// On some versionms of Linux (e.g. Centos) this test won't work as the
// modified time accuracy is only to the second.
long beforeSeconds = before/1000L;
long afterSeconds = after/1000L;
long modifiedTimeCheckSeconds = modifiedTimeCheck/1000L;
assertTrue("Reader last modified is incorrect", beforeSeconds <= modifiedTimeCheckSeconds);
assertTrue("Reader last modified is incorrect", modifiedTimeCheckSeconds <= afterSeconds);
}
/**
* Check that a reader is immutable, i.e. that a reader fetched before a
* write doesn't suddenly become aware of the content once it has been written.
*/
public void testReaderImmutability()
{
ContentWriter writer = getWriter();
ContentReader readerBeforeWrite = writer.getReader();
assertNotNull(readerBeforeWrite);
assertFalse(readerBeforeWrite.exists());
// Write some content
writer.putContent("Content for " + getName());
assertFalse("Reader's state changed after write", readerBeforeWrite.exists());
try
{
readerBeforeWrite.getContentString();
fail("Reader's state changed after write");
}
catch (ContentIOException e)
{
// Expected
}
// A new reader should work
ContentReader readerAfterWrite = writer.getReader();
assertTrue("New reader after write should be directed to new content", readerAfterWrite.exists());
}
public void testMimetypAndEncodingAndLocale() throws Exception
{
ContentWriter writer = getWriter();
// set mimetype and encoding
writer.setMimetype("text/plain");
writer.setEncoding("UTF-16");
writer.setLocale(Locale.CHINESE);
// create a UTF-16 string
String content = "A little bit o' this and a little bit o' that";
byte[] bytesUtf16 = content.getBytes("UTF-16");
// write the bytes directly to the writer
OutputStream os = writer.getContentOutputStream();
os.write(bytesUtf16);
os.close();
// now get a reader from the writer
ContentReader reader = writer.getReader();
assertEquals("Writer -> Reader content URL mismatch", writer.getContentUrl(), reader.getContentUrl());
assertEquals("Writer -> Reader mimetype mismatch", writer.getMimetype(), reader.getMimetype());
assertEquals("Writer -> Reader encoding mismatch", writer.getEncoding(), reader.getEncoding());
assertEquals("Writer -> Reader locale mismatch", writer.getLocale(), reader.getLocale());
// now get the string directly from the reader
String contentCheck = reader.getContentString(); // internally it should have taken care of the encoding
assertEquals("Encoding and decoding of strings failed", content, contentCheck);
}
public void testClosedState() throws Exception
{
ContentWriter writer = getWriter();
ContentReader readerBeforeWrite = writer.getReader();
// check that streams are not flagged as closed
assertFalse("Reader stream should not be closed", readerBeforeWrite.isClosed());
assertFalse("Writer stream should not be closed", writer.isClosed());
// write some stuff
writer.putContent("ABC");
// check that the write has been closed
assertTrue("Writer stream should be closed", writer.isClosed());
// check that we can get a reader from the writer
ContentReader readerAfterWrite = writer.getReader();
assertNotNull("No reader given by closed writer", readerAfterWrite);
assertFalse("Before-content reader should not be affected by content updates", readerBeforeWrite.isClosed());
assertFalse("After content reader should not be closed", readerAfterWrite.isClosed());
// check that the instance is new each time
ContentReader newReaderA = writer.getReader();
ContentReader newReaderB = writer.getReader();
assertFalse("Reader must always be a new instance", newReaderA == newReaderB);
// check that the readers refer to the same URL
assertEquals("Readers should refer to same URL",
readerBeforeWrite.getContentUrl(), readerAfterWrite.getContentUrl());
// read their content
try
{
readerBeforeWrite.getContentString();
}
catch (Throwable e)
{
// The content doesn't exist for this reader
}
String contentCheck = readerAfterWrite.getContentString();
assertEquals("Incorrect content", "ABC", contentCheck);
// check closed state of readers
assertFalse("Before-content reader stream should not be closed", readerBeforeWrite.isClosed());
assertTrue("After-content reader should be closed after reading", readerAfterWrite.isClosed());
}
/**
* Helper method to check if a store contains a particular URL using the getUrl method
*/
private boolean searchForUrl(ContentStore store, final String contentUrl, Date from, Date to)
{
final boolean[] found = new boolean[] {false};
ContentUrlHandler handler = new ContentUrlHandler()
{
public void handle(String checkContentUrl)
{
if (contentUrl.equals(checkContentUrl))
{
found[0] = true;
}
}
};
getStore().getUrls(from, to, handler);
return found[0];
}
public void testGetUrls()
{
ContentWriter writer = getWriter();
writer.putContent("Content for " + getName());
final String contentUrl = writer.getContentUrl();
ContentStore store = getStore();
boolean inStore = searchForUrl(store, contentUrl, null, null);
assertTrue("New content not found in URL set", inStore);
}
public void testDeleteSimple() throws Exception
{
ContentStore store = getStore();
ContentWriter writer = getWriter();
writer.putContent("Content for " + getName());
String contentUrl = writer.getContentUrl();
assertTrue("Content must now exist", store.exists(contentUrl));
try
{
store.delete(contentUrl);
}
catch (UnsupportedOperationException e)
{
logger.warn("Store test " + getName() + " not possible on " + store.getClass().getName());
return;
}
assertFalse("Content must now be removed", store.exists(contentUrl));
}
/**
* Tests deletion of content.
* <p>
* Only applies when {@link #getStore()} returns a value.
*/
public void testDeleteReaderStates() throws Exception
{
ContentStore store = getStore();
ContentWriter writer = getWriter();
String content = "Content for " + getName();
String contentUrl = writer.getContentUrl();
// write some bytes, but don't close the stream
OutputStream os = writer.getContentOutputStream();
os.write(content.getBytes());
os.flush(); // make sure that the bytes get persisted
// close the stream
os.close();
// get a reader
ContentReader reader = store.getReader(contentUrl);
assertNotNull(reader);
ContentReader readerCheck = writer.getReader();
assertNotNull(readerCheck);
assertEquals("Store and write provided readers onto different URLs",
writer.getContentUrl(), reader.getContentUrl());
// open the stream onto the content
InputStream is = reader.getContentInputStream();
// attempt to delete the content
boolean deleted = store.delete(contentUrl);
// close the reader stream
is.close();
// get a fresh reader
reader = store.getReader(contentUrl);
assertNotNull(reader);
// the underlying system may or may not have deleted the content
if (deleted)
{
assertFalse("Content should not exist", reader.exists());
// drop out here
return;
}
else
{
assertTrue("Content should exist", reader.exists());
}
// delete the content
store.delete(contentUrl);
// attempt to read from the reader
try
{
is = reader.getContentInputStream();
fail("Reader failed to detect underlying content deletion");
}
catch (ContentIOException e)
{
// expected
}
// get another fresh reader
reader = store.getReader(contentUrl);
assertNotNull("Reader must be returned even when underlying content is missing",
reader);
assertFalse("Content should not exist", reader.exists());
try
{
is = reader.getContentInputStream();
fail("Reader opened stream onto missing content");
}
catch (ContentIOException e)
{
// expected
}
}
/**
* Checks that the writer can have a listener attached
*/
public void testWriteStreamListener() throws Exception
{
ContentWriter writer = getWriter();
final boolean[] streamClosed = new boolean[] {false}; // has to be final
ContentStreamListener listener = new ContentStreamListener()
{
public void contentStreamClosed() throws ContentIOException
{
streamClosed[0] = true;
}
};
writer.addListener(listener);
// write some content
writer.putContent("ABC");
// check that the listener was called
assertTrue("Write stream listener was not called for the stream close", streamClosed[0]);
}
/**
* The simplest test. Write a string and read it again, checking that we receive the same values.
* If the resource accessed by {@link #getReader()} and {@link #getWriter()} is not the same, then
* values written and read won't be the same.
*/
public void testWriteAndReadString() throws Exception
{
ContentWriter writer = getWriter();
String content = "ABC";
writer.putContent(content);
assertTrue("Stream close not detected", writer.isClosed());
ContentReader reader = writer.getReader();
String check = reader.getContentString();
assertTrue("Read and write may not share same resource", check.length() > 0);
assertEquals("Write and read didn't work", content, check);
}
public void testStringTruncation() throws Exception
{
String content = "1234567890";
ContentWriter writer = getWriter();
writer.setMimetype(MimetypeMap.MIMETYPE_TEXT_PLAIN);
writer.setEncoding("UTF-8"); // shorter format i.t.o. bytes used
// write the content
writer.putContent(content);
// get a reader - get it in a larger format i.t.o. bytes
ContentReader reader = writer.getReader();
String checkContent = reader.getContentString(5);
assertEquals("Truncated strings don't match", "12345", checkContent);
}
public void testReadAndWriteFile() throws Exception
{
ContentWriter writer = getWriter();
File sourceFile = File.createTempFile(getName(), ".txt");
sourceFile.deleteOnExit();
// dump some content into the temp file
String content = "ABC";
FileOutputStream os = new FileOutputStream(sourceFile);
os.write(content.getBytes());
os.flush();
os.close();
// put our temp file's content
writer.putContent(sourceFile);
assertTrue("Stream close not detected", writer.isClosed());
// create a sink temp file
File sinkFile = File.createTempFile(getName(), ".txt");
sinkFile.deleteOnExit();
// get the content into our temp file
ContentReader reader = writer.getReader();
reader.getContent(sinkFile);
// read the sink file manually
FileInputStream is = new FileInputStream(sinkFile);
byte[] buffer = new byte[100];
int count = is.read(buffer);
assertEquals("No content read", 3, count);
is.close();
String check = new String(buffer, 0, count);
assertEquals("Write out of and read into files failed", content, check);
}
public void testReadAndWriteStreamByPull() throws Exception
{
ContentWriter writer = getWriter();
String content = "ABC";
// put the content using a stream
InputStream is = new ByteArrayInputStream(content.getBytes());
writer.putContent(is);
assertTrue("Stream close not detected", writer.isClosed());
// get the content using a stream
ByteArrayOutputStream os = new ByteArrayOutputStream(100);
ContentReader reader = writer.getReader();
reader.getContent(os);
byte[] bytes = os.toByteArray();
String check = new String(bytes);
assertEquals("Write out and read in using streams failed", content, check);
}
public void testReadAndWriteStreamByPush() throws Exception
{
ContentWriter writer = getWriter();
String content = "ABC";
// get the content output stream
OutputStream os = writer.getContentOutputStream();
os.write(content.getBytes());
assertFalse("Stream has not been closed", writer.isClosed());
// close the stream and check again
os.close();
assertTrue("Stream close not detected", writer.isClosed());
// pull the content from a stream
ContentReader reader = writer.getReader();
InputStream is = reader.getContentInputStream();
byte[] buffer = new byte[100];
int count = is.read(buffer);
assertEquals("No content read", 3, count);
is.close();
String check = new String(buffer, 0, count);
assertEquals("Write out of and read into files failed", content, check);
}
/**
* Tests retrieval of all content URLs
* <p>
* Only applies when {@link #getStore()} returns a value.
*/
public void testListUrls() throws Exception
{
ContentStore store = getStore();
// Ensure that this test can be done
try
{
searchForUrl(store, "abc", null, null);
}
catch (UnsupportedOperationException e)
{
logger.warn("Store test " + getName() + " not possible on " + store.getClass().getName());
return;
}
// Proceed with the test
ContentWriter writer = getWriter();
String contentUrl = writer.getContentUrl();
boolean inStore = searchForUrl(store, contentUrl, null, null);
assertTrue("Writer URL not listed by store", inStore);
Date yesterday = new Date(System.currentTimeMillis() - 3600L * 1000L * 24L);
// write some data
writer.putContent("The quick brown fox...");
// check again
inStore = searchForUrl(store, contentUrl, null, null);
assertTrue("Writer URL not listed by store", inStore);
// check that the query for content created before this time yesterday doesn't return the URL
inStore = searchForUrl(store, contentUrl, null, yesterday);
assertFalse("URL was younger than required, but still shows up", inStore);
}
/**
* Tests random access writing
* <p>
* Only executes if the writer implements {@link RandomAccessContent}.
*/
public void testRandomAccessWrite() throws Exception
{
ContentWriter writer = getWriter();
FileChannel fileChannel = writer.getFileChannel(true);
assertNotNull("No channel given", fileChannel);
// check that no other content access is allowed
try
{
writer.getWritableChannel();
fail("Second channel access allowed");
}
catch (RuntimeException e)
{
// expected
}
// write some content in a random fashion (reverse order)
byte[] content = new byte[] {1, 2, 3};
for (int i = content.length - 1; i >= 0; i--)
{
ByteBuffer buffer = ByteBuffer.wrap(content, i, 1);
fileChannel.write(buffer, i);
}
// close the channel
fileChannel.close();
assertTrue("Writer not closed", writer.isClosed());
// check the content
ContentReader reader = writer.getReader();
ReadableByteChannel channelReader = reader.getReadableChannel();
ByteBuffer buffer = ByteBuffer.allocateDirect(3);
int count = channelReader.read(buffer);
assertEquals("Incorrect number of bytes read", 3, count);
for (int i = 0; i < content.length; i++)
{
assertEquals("Content doesn't match", content[i], buffer.get(i));
}
// get a new writer from the store, using the existing content and perform a truncation check
ContentContext writerTruncateCtx = new ContentContext(writer.getReader(), null);
ContentWriter writerTruncate = getStore().getWriter(writerTruncateCtx);
assertEquals("Content size incorrect", 0, writerTruncate.getSize());
// get the channel with truncation
FileChannel fcTruncate = writerTruncate.getFileChannel(true);
fcTruncate.close();
assertEquals("Content not truncated", 0, writerTruncate.getSize());
// get a new writer from the store, using the existing content and perform a non-truncation check
ContentContext writerNoTruncateCtx = new ContentContext(writer.getReader(), null);
ContentWriter writerNoTruncate = getStore().getWriter(writerNoTruncateCtx);
assertEquals("Content size incorrect", 0, writerNoTruncate.getSize());
// get the channel without truncation
FileChannel fcNoTruncate = writerNoTruncate.getFileChannel(false);
fcNoTruncate.close();
assertEquals("Content was truncated", writer.getSize(), writerNoTruncate.getSize());
}
/**
* Tests random access reading
* <p>
* Only executes if the reader implements {@link RandomAccessContent}.
*/
public void testRandomAccessRead() throws Exception
{
ContentWriter writer = getWriter();
// put some content
String content = "ABC";
byte[] bytes = content.getBytes();
writer.putContent(content);
ContentReader reader = writer.getReader();
FileChannel fileChannel = reader.getFileChannel();
assertNotNull("No channel given", fileChannel);
// check that no other content access is allowed
try
{
reader.getReadableChannel();
fail("Second channel access allowed");
}
catch (RuntimeException e)
{
// expected
}
// read the content
ByteBuffer buffer = ByteBuffer.allocate(bytes.length);
int count = fileChannel.read(buffer);
assertEquals("Incorrect number of bytes read", bytes.length, count);
// transfer back to array
buffer.rewind();
buffer.get(bytes);
String checkContent = new String(bytes);
assertEquals("Content read failure", content, checkContent);
fileChannel.close();
}
}