/**
* Fetches the attachment content from the repository. Content is flat text that can be used for
* indexing/searching or display
*
* @param attachmentName Name of the attachment.
* @param version The version of the attachment.
* @return the content of the Attachment as a String.
*/
protected String getAttachmentContent(String attachmentName, int version) {
AttachmentManager mgr = m_engine.getAttachmentManager();
try {
Attachment att = mgr.getAttachmentInfo(attachmentName, version);
// FIXME: Find out why sometimes att is null
if (att != null) {
return getAttachmentContent(att);
}
} catch (ProviderException e) {
log.error("Attachment cannot be loaded", e);
}
// Something was wrong, no result is returned.
return null;
}
private Set<String> getReferencesToChange(WikiPage fromPage, WikiEngine engine) {
Set<String> referrers = new TreeSet<String>();
Collection<String> r = engine.getReferenceManager().findReferrers(fromPage.getName());
if (r != null) referrers.addAll(r);
try {
Collection<Attachment> attachments = engine.getAttachmentManager().listAttachments(fromPage);
for (Attachment att : attachments) {
Collection<String> c = engine.getReferenceManager().findReferrers(att.getName());
if (c != null) referrers.addAll(c);
}
} catch (ProviderException e) {
// We will continue despite this error
log.error("Provider error while fetching attachments for rename", e);
}
return referrers;
}
/**
* @param att Attachment to get content for. Filename extension is used to determine the type of
* the attachment.
* @return String representing the content of the file. FIXME This is a very simple implementation
* of some text-based attachment, mainly used for testing. This should be replaced /moved to
* Attachment search providers or some other 'pluggable' wat to search attachments
*/
protected String getAttachmentContent(Attachment att) {
AttachmentManager mgr = m_engine.getAttachmentManager();
// FIXME: Add attachment plugin structure
String filename = att.getFileName();
boolean searchSuffix = false;
for (String suffix : SEARCHABLE_FILE_SUFFIXES) {
if (filename.endsWith(suffix)) {
searchSuffix = true;
}
}
if (searchSuffix) {
InputStream attStream;
try {
attStream = mgr.getAttachmentStream(att);
StringWriter sout = new StringWriter();
FileUtil.copyContents(new InputStreamReader(attStream), sout);
attStream.close();
sout.close();
return sout.toString();
} catch (ProviderException e) {
log.error("Attachment cannot be loaded", e);
return null;
} catch (IOException e) {
log.error("Attachment cannot be loaded", e);
return null;
}
}
return null;
}
/**
* Renames a page.
*
* @param context The current context.
* @param renameFrom The name from which to rename.
* @param renameTo The new name.
* @param changeReferrers If true, also changes all the referrers.
* @return The final new name (in case it had to be modified)
* @throws WikiException If the page cannot be renamed.
*/
public String renamePage(
WikiContext context, String renameFrom, String renameTo, boolean changeReferrers)
throws WikiException {
//
// Sanity checks first
//
if (renameFrom == null || renameFrom.length() == 0) {
throw new WikiException("From name may not be null or empty");
}
if (renameTo == null || renameTo.length() == 0) {
throw new WikiException("To name may not be null or empty");
}
//
// Clean up the "to" -name so that it does not contain anything illegal
//
renameTo = MarkupParser.cleanLink(renameTo.trim());
if (renameTo.equals(renameFrom)) {
throw new WikiException("You cannot rename the page to itself");
}
//
// Preconditions: "from" page must exist, and "to" page must not yet exist.
//
WikiEngine engine = context.getEngine();
WikiPage fromPage = engine.getPage(renameFrom);
if (fromPage == null) {
throw new WikiException("No such page " + renameFrom);
}
WikiPage toPage = engine.getPage(renameTo);
if (toPage != null) {
throw new WikiException("Page already exists " + renameTo);
}
//
// Options
//
m_camelCase =
TextUtil.getBooleanProperty(
engine.getWikiProperties(), JSPWikiMarkupParser.PROP_CAMELCASELINKS, m_camelCase);
Set<String> referrers = getReferencesToChange(fromPage, engine);
//
// Do the actual rename by changing from the frompage to the topage, including
// all of the attachments
//
engine.getPageManager().getProvider().movePage(renameFrom, renameTo);
if (engine.getAttachmentManager().attachmentsEnabled()) {
engine
.getAttachmentManager()
.getCurrentProvider()
.moveAttachmentsForPage(renameFrom, renameTo);
}
//
// Add a comment to the page notifying what changed. This adds a new revision
// to the repo with no actual change.
//
toPage = engine.getPage(renameTo);
if (toPage == null)
throw new InternalWikiException(
"Rename seems to have failed for some strange reason - please check logs!");
toPage.setAttribute(WikiPage.CHANGENOTE, fromPage.getName() + " ==> " + toPage.getName());
toPage.setAuthor(context.getCurrentUser().getName());
engine.getPageManager().putPageText(toPage, engine.getPureText(toPage));
//
// Update the references
//
engine.getReferenceManager().pageRemoved(fromPage);
engine.updateReferences(toPage);
//
// Update referrers
//
if (changeReferrers) {
updateReferrers(context, fromPage, toPage, referrers);
}
//
// re-index the page
//
engine.getSearchManager().reindexPage(toPage);
Collection<Attachment> attachments = engine.getAttachmentManager().listAttachments(toPage);
for (Attachment att : attachments) {
engine.getSearchManager().reindexPage(att);
}
//
// Done, return the new name.
//
return renameTo;
}
/**
* Indexes page using the given IndexWriter.
*
* @param page WikiPage
* @param text Page text to index
* @param writer The Lucene IndexWriter to use for indexing
* @return the created index Document
* @throws IOException If there's an indexing problem
*/
protected Document luceneIndexPage(WikiPage page, String text, IndexWriter writer)
throws IOException {
if (log.isDebugEnabled()) log.debug("Indexing " + page.getName() + "...");
// make a new, empty document
Document doc = new Document();
if (text == null) return doc;
// Raw name is the keyword we'll use to refer to this document for updates.
Field field = new Field(LUCENE_ID, page.getName(), Field.Store.YES, Field.Index.NOT_ANALYZED);
doc.add(field);
// Body text. It is stored in the doc for search contexts.
field =
new Field(
LUCENE_PAGE_CONTENTS, text, Field.Store.YES, Field.Index.ANALYZED, Field.TermVector.NO);
doc.add(field);
// Allow searching by page name. Both beautified and raw
String unTokenizedTitle =
StringUtils.replaceChars(
page.getName(), MarkupParser.PUNCTUATION_CHARS_ALLOWED, c_punctuationSpaces);
field =
new Field(
LUCENE_PAGE_NAME,
TextUtil.beautifyString(page.getName()) + " " + unTokenizedTitle,
Field.Store.YES,
Field.Index.ANALYZED,
Field.TermVector.NO);
doc.add(field);
// Allow searching by authorname
if (page.getAuthor() != null) {
field =
new Field(
LUCENE_AUTHOR,
page.getAuthor(),
Field.Store.YES,
Field.Index.ANALYZED,
Field.TermVector.NO);
doc.add(field);
}
// Now add the names of the attachments of this page
try {
Collection attachments = m_engine.getAttachmentManager().listAttachments(page);
String attachmentNames = "";
for (Iterator it = attachments.iterator(); it.hasNext(); ) {
Attachment att = (Attachment) it.next();
attachmentNames += att.getName() + ";";
}
field =
new Field(
LUCENE_ATTACHMENTS,
attachmentNames,
Field.Store.YES,
Field.Index.ANALYZED,
Field.TermVector.NO);
doc.add(field);
} catch (ProviderException e) {
// Unable to read attachments
log.error("Failed to get attachments for page", e);
}
writer.addDocument(doc);
return doc;
}
/**
* Performs a full Lucene reindex, if necessary.
*
* @throws IOException If there's a problem during indexing
*/
protected void doFullLuceneReindex() throws IOException {
File dir = new File(m_luceneDirectory);
String[] filelist = dir.list();
if (filelist == null) {
throw new IOException(
"Invalid Lucene directory: cannot produce listing: " + dir.getAbsolutePath());
}
try {
if (filelist.length == 0) {
//
// No files? Reindex!
//
Date start = new Date();
IndexWriter writer = null;
log.info("Starting Lucene reindexing, this can take a couple minutes...");
Directory luceneDir = new SimpleFSDirectory(dir, null);
try {
writer = getIndexWriter(luceneDir);
Collection allPages = m_engine.getPageManager().getAllPages();
for (Iterator iterator = allPages.iterator(); iterator.hasNext(); ) {
WikiPage page = (WikiPage) iterator.next();
try {
String text =
m_engine
.getPageManager()
.getPageText(page.getName(), WikiProvider.LATEST_VERSION);
luceneIndexPage(page, text, writer);
} catch (IOException e) {
log.warn("Unable to index page " + page.getName() + ", continuing to next ", e);
}
}
Collection allAttachments = m_engine.getAttachmentManager().getAllAttachments();
for (Iterator iterator = allAttachments.iterator(); iterator.hasNext(); ) {
Attachment att = (Attachment) iterator.next();
try {
String text = getAttachmentContent(att.getName(), WikiProvider.LATEST_VERSION);
luceneIndexPage(att, text, writer);
} catch (IOException e) {
log.warn("Unable to index attachment " + att.getName() + ", continuing to next", e);
}
}
} finally {
close(writer);
}
Date end = new Date();
log.info(
"Full Lucene index finished in "
+ (end.getTime() - start.getTime())
+ " milliseconds.");
} else {
log.info("Files found in Lucene directory, not reindexing.");
}
} catch (NoClassDefFoundError e) {
log.info("Lucene libraries do not exist - not using Lucene.");
} catch (IOException e) {
log.error("Problem while creating Lucene index - not using Lucene.", e);
} catch (ProviderException e) {
log.error("Problem reading pages while creating Lucene index (JSPWiki won't start.)", e);
throw new IllegalArgumentException("unable to create Lucene index");
} catch (Exception e) {
log.error("Unable to start lucene", e);
}
}
