diff options
Diffstat (limited to 'org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/bugzilla/search/BugzillaMylarSearchOperation.java')
-rw-r--r-- | org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/bugzilla/search/BugzillaMylarSearchOperation.java | 526 |
1 files changed, 0 insertions, 526 deletions
diff --git a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/bugzilla/search/BugzillaMylarSearchOperation.java b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/bugzilla/search/BugzillaMylarSearchOperation.java deleted file mode 100644 index 04f632e81..000000000 --- a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/tasks/bugzilla/search/BugzillaMylarSearchOperation.java +++ /dev/null @@ -1,526 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2004 - 2005 University Of British Columbia and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * University Of British Columbia - initial API and implementation - *******************************************************************************/ -/* - * Created on Oct 14, 2004 - */ -package org.eclipse.mylar.tasks.bugzilla.search; - -import java.util.ArrayList; -import java.util.Iterator; -import java.util.List; - -import javax.security.auth.login.LoginException; - -import org.eclipse.core.runtime.CoreException; -import org.eclipse.core.runtime.IProgressMonitor; -import org.eclipse.core.runtime.IStatus; -import org.eclipse.core.runtime.Status; -import org.eclipse.jdt.core.IJavaElement; -import org.eclipse.jdt.core.IMember; -import org.eclipse.jdt.core.IType; -import org.eclipse.jface.resource.ImageDescriptor; -import org.eclipse.mylar.bugzilla.core.BugReport; -import org.eclipse.mylar.bugzilla.core.Comment; -import org.eclipse.mylar.bugzilla.search.BugzillaSearchEngine; -import org.eclipse.mylar.bugzilla.search.BugzillaSearchHit; -import org.eclipse.mylar.bugzilla.search.BugzillaSearchQuery; -import org.eclipse.mylar.bugzilla.search.IBugzillaSearchOperation; -import org.eclipse.mylar.core.MylarPlugin; -import org.eclipse.mylar.tasks.BugzillaTask; -import org.eclipse.mylar.tasks.ITask; -import org.eclipse.mylar.tasks.MylarTasksPlugin; -import org.eclipse.mylar.tasks.bugzilla.BugzillaReportNode; -import org.eclipse.mylar.tasks.bugzilla.StackTrace; -import org.eclipse.mylar.tasks.bugzilla.Util; -import org.eclipse.ui.actions.WorkspaceModifyOperation; - - -/** - * Bugzilla search operation for Mylar - * - * @author Shawn Minto - */ -public class BugzillaMylarSearchOperation extends WorkspaceModifyOperation - implements IBugzillaSearchOperation { - /** The IMember we are doing the search for */ - private IMember javaElement; - - /** The bugzilla collector for the search */ - private BugzillaResultCollector collector = null; - - /** The status of the search operation */ - private IStatus status; - - /** The LoginException that was thrown when trying to do the search */ - private LoginException loginException = null; - - /** The fully qualified name of the member we are searching for */ - private String name; - - /** The bugzilla search query */ - private BugzillaSearchQuery query; - - private BugzillaMylarSearch search; - - private int scope; - - /** - * Constructor - * - * @param m - * The member that we are doing the search for - */ - public BugzillaMylarSearchOperation(BugzillaMylarSearch search, IMember m, int scope) { - this.javaElement = m; - this.search = search; - this.scope = scope; - name = getFullyQualifiedName(m); - } - - /** - * Get the fully qualified name of a IMember - * TODO: move to a more central location so that others can use this, but don't want to add unecessary coupling - * - * @return String representing the fully qualified name - */ - public static String getFullyQualifiedName(IJavaElement je) { - if(!(je instanceof IMember)) return null; - - IMember m = (IMember)je; - if (m.getDeclaringType() == null) - return ((IType) m).getFullyQualifiedName(); - else - return m.getDeclaringType().getFullyQualifiedName() + "." - + m.getElementName(); - } - - @Override - public void execute(IProgressMonitor monitor) { - - BugzillaResultCollector searchCollector = null; - - if(scope == BugzillaMylarSearch.FULLY_QUAL){ - searchCollector = searchQualified(monitor); - }else if(scope == BugzillaMylarSearch.UNQUAL){ - searchCollector = searchUnqualified(monitor); - }else if(scope == BugzillaMylarSearch.LOCAL_QUAL){ - searchCollector = searchLocalQual(monitor); - }else if(scope == BugzillaMylarSearch.LOCAL_UNQUAL){ - searchCollector = searchLocalUnQual(monitor); - }else{ - return; - } - - if(searchCollector == null){ - search.notifySearchCompleted( - new ArrayList<BugzillaReportNode>()); - return; - } - - List<BugzillaSearchHit> l = searchCollector.getResults(); - - // get the list of doi elements - List<BugzillaReportNode> doiList = getDoiList(l); - - // we completed the search, so notify all of the listeners - // that the search has been completed - MylarTasksPlugin.getBridge() - .addToLandmarksHash(doiList, javaElement, scope); - search.notifySearchCompleted( - doiList); - // MIK: commmented out logging -// MonitorPlugin.log(this, "There were " + doiList.size() + " items found"); - } - - /** - * Search the local bugs for the member using the qualified name - * @param monitor The progress monitor to search with - * @return The BugzillaResultCollector with the results of the search - */ - private BugzillaResultCollector searchLocalQual(IProgressMonitor monitor) { - - //get the fully qualified name for searching - String elementName = getFullyQualifiedName(javaElement); - - // setup the search result collector - collector = new BugzillaResultCollector(); - collector.setOperation(this); - collector.setProgressMonitor(monitor); - - // get all of the root tasks and start the search - List<ITask> tasks = MylarTasksPlugin.getTaskListManager().getTaskList().getRootTasks(); - searchLocal(tasks, collector, elementName, monitor); - - // return the collector - return collector; - } - - /** - * Search the local bugs for the member using the unqualified name - * @param monitor The progress monitor to search with - * @return The BugzillaResultCollector with the results of the search - */ - private BugzillaResultCollector searchLocalUnQual(IProgressMonitor monitor) { - - // get the element name for searching - String elementName = javaElement.getElementName(); - - // setup the search result collector - collector = new BugzillaResultCollector(); - collector.setOperation(this); - collector.setProgressMonitor(monitor); - - // get all of the root tasks and start the search - List<ITask> tasks = MylarTasksPlugin.getTaskListManager().getTaskList().getRootTasks(); - searchLocal(tasks, collector, elementName, monitor); - - // return the collector - return collector; - } - - /** - * Search the local bugs for the member - * @param tasks The tasks to search - * @param searchCollector The collector to add the results to - * @param elementName The name of the element that we are looking for - * @param monitor The progress monitor - */ - private void searchLocal(List<ITask> tasks, BugzillaResultCollector searchCollector, String elementName, IProgressMonitor monitor) { - if(tasks == null) return; - - // go through all of the tasks - for(ITask task : tasks){ - monitor.worked(1); - - // check what kind of task it is - if(task instanceof BugzillaTask){ - - // we have a bugzilla task, so get the bug report - BugzillaTask bugTask = (BugzillaTask)task; - BugReport bug = bugTask.getBugReport(); - - // parse the bug report for the element that we are searching for - boolean isHit = search(elementName, bug); - - // determine if we have a hit or not - if(isHit){ - - // make a search hit from the bug and then add it to the collector - BugzillaSearchHit hit = new BugzillaSearchHit(bug.getId(), bug.getDescription(), "","","","","","","", bug.getServer()); - try{ - searchCollector.accept(hit); - }catch(CoreException e){ - MylarPlugin.log(e, "bug search failed"); - } - } - } - - // get the children and perform the search on them as well - List<ITask> children = task.getChildren(); - if(children != null){ - searchLocal(children, searchCollector, elementName, monitor); - } - } - status = Status.OK_STATUS; - } - - /** - * Search the bug for the given element name - * @param elementName The name of the element to search for - * @param bug The bug to search in - */ - private boolean search(String elementName, BugReport bug) { - - if (bug == null) return false; // MIK: added null check here - String description = bug.getDescription(); - String summary = bug.getSummary(); - List<Comment> comments = bug.getComments(); - - // search the description and the summary - if(Util.hasElementName(elementName, summary)) - return true; - - if(Util.hasElementName(elementName, description)) - return true; - - Iterator<Comment> comItr = comments.iterator(); - while (comItr.hasNext()) { - Comment comment = comItr.next(); - String commentText = comment.getText(); - // search the text for a reference to the element - if(Util.hasElementName(elementName, commentText)) - return true; - } - return false; - } - - /** - * Perform the actual search on the Bugzilla server - * @param url The url to use for the search - * @param searchCollector The collector to put the search results into - * @param monitor The progress monitor to use for the search - * @return The BugzillaResultCollector with the search results - */ - private BugzillaResultCollector search(String url, BugzillaResultCollector searchCollector, IProgressMonitor monitor){ - - // set the initial number of matches to 0 - int matches = 0; - // setup the progress monitor and start the search - searchCollector.setProgressMonitor(monitor); - BugzillaSearchEngine engine = new BugzillaSearchEngine(url); - try { - - // perform the search - status = engine.search(searchCollector, matches); - - // check the status so that we don't keep searching if there - // is a problem - if (status.getCode() == IStatus.CANCEL) { - MylarPlugin.log("search cancelled", this); - return null; - } else if (!status.isOK()) { - MylarPlugin.log("search error", this); - MylarPlugin.log(status); - return null; - } - return searchCollector; - } catch (LoginException e) { - //save this exception to throw later - this.loginException = e; - } - return null; - } - - /** - * Perform a search for qualified instances of the member - * @param monitor The progress monitor to use - * @return The BugzillaResultCollector with the search results - */ - private BugzillaResultCollector searchQualified(IProgressMonitor monitor) - { - // create a new collector for the results - collector = new BugzillaResultCollector(); - collector.setOperation(this); - collector.setProgressMonitor(monitor); - - // get the search url - String url = Util.getExactSearchURL(javaElement); - - // log the url that we are searching with - // MIK: commmented out logging -// MonitorPlugin.log(this, url); - - return search(url, collector, monitor); - } - - /** - * Perform a search for unqualified instances of the member - * @param monitor The progress monitor to use - * @return The BugzillaResultCollector with the search results - */ - private BugzillaResultCollector searchUnqualified(IProgressMonitor monitor) - { - // create a new collector for the results - collector = new BugzillaResultCollector(); - collector.setOperation(this); - collector.setProgressMonitor(monitor); - - // get the search url - String url = Util.getInexactSearchURL(javaElement); - - // log the url that we are searching with - // MIK: commmented out logging -// MonitorPlugin.log(this, url); - - return search(url, collector, monitor); - } - -// /** -// * Remove all of the duplicates -// * @param compare The List of BugzillaSearchHits to compare with -// * @param base The List of BugzillaSearchHits to remove the duplicates from -// */ -// private void removeDuplicates(List<BugzillaSearchHit> compare, List<BugzillaSearchHit> base){ -// -// for(BugzillaSearchHit h1 : compare){ -// Iterator itr2 = base.iterator(); -// while(itr2.hasNext()){ -// BugzillaSearchHit h2 = (BugzillaSearchHit)itr2.next(); -// if(h2.getId() == h1.getId()){ -// // we found a duplicate so remove it -// itr2.remove(); -// break; -// } -// } -// } -// } -// - /** - * Perform a second pass parse to determine if there are any stack traces in - * the bug - currently only used for the exact search results - * - * @param doiList - - * the list of BugzillaSearchHitDOI elements to parse - */ - public static void secondPassBugzillaParser(List<BugzillaReportNode> doiList) { - - // go through each of the items in the doiList - for(BugzillaReportNode info : doiList) { - - // get the bug report so that we have all of the data - // - descriptions, comments, etc - BugReport b = null; - try{ - b = info.getBug(); - }catch(Exception e){ - // don't care since null will be caught - } - - // if the report could not be downloaded, try the next one - if (b == null) - continue; - - // see if the description has a stack trace in it - StackTrace[] stackTrace = StackTrace.getStackTrace(b.getDescription(), b.getDescription()); - if (stackTrace != null) { - - // add the stack trace to the doi info - info.setExact(true); - info.addStackTraces(stackTrace); - } - - // go through all of the comments for the bug - Iterator<Comment> comItr = b.getComments().iterator(); - while (comItr.hasNext()) { - Comment comment = comItr.next(); - String commentText = comment.getText(); - - // see if the comment has a stack trace in it - stackTrace = StackTrace.getStackTrace(commentText, comment); - if (stackTrace != null) { - - // add the stack trace to the doi info - info.setExact(true); - info.addStackTraces(stackTrace); - } - } - } - } - - /** - * Add the results returned to the Hash of landmarks - * - * @param results - * The list of results - * @param isExact - * whether the search was exact or not - */ - private List<BugzillaReportNode> getDoiList(List<BugzillaSearchHit> results) { - List<BugzillaReportNode> doiList = new ArrayList<BugzillaReportNode>(); - - boolean isExact = (scope==BugzillaMylarSearch.FULLY_QUAL || scope==BugzillaMylarSearch.LOCAL_QUAL)?true:false; - - BugzillaReportNode info = null; - // go through all of the results and create a DoiInfo list - for(BugzillaSearchHit hit : results){ - - try { - float value = 0; - info = new BugzillaReportNode( - value, hit, isExact); - - // only download the bug for the exact matches - //downloading bugs kills the time - can we do this elsewhere? - different thread? persistant? -// if(isExact){ -// // get the bug report for the doi info item -// BugReport b = BugzillaRepository.getInstance().getBug( -// hit.getId()); -// // add the bug to the doi info for future use -// info.setBug(b); -// } - - } catch (Exception e) { - MylarPlugin.log(e, "search failed"); - } - finally{ - doiList.add(info); - } - } - return doiList; - } - - /** - * @see org.eclipse.mylar.bugzilla.search.IBugzillaSearchOperation#getStatus() - */ - public IStatus getStatus() throws LoginException { - // if a LoginException was thrown while trying to search, throw this - if (loginException == null) - return status; - else - throw loginException; - } - - /** - * @see org.eclipse.mylar.bugzilla.search.IBugzillaSearchOperation#getImageDescriptor() - */ - public ImageDescriptor getImageDescriptor() { - return null; - } - - /** - * Get the member that we are performing the search for - * - * @return The member this search is being performed for - */ - public IMember getSearchMember() { - return javaElement; - } - - /** - * Get the name of the member that we are searching for - * - * @return The fully qualified name of the member - */ - public String getSearchMemberName() { - return name; - } - - /** - * @see org.eclipse.mylar.bugzilla.search.IBugzillaSearchOperation#getQuery() - */ - public BugzillaSearchQuery getQuery() { - return query; - } - - /** - * @see org.eclipse.mylar.bugzilla.search.IBugzillaSearchOperation#setQuery(org.eclipse.mylar.bugzilla.search.BugzillaSearchQuery) - */ - public void setQuery(BugzillaSearchQuery newQuery) { - this.query = newQuery; - } - - /** - * Get the name of the element that we are searching for - * - * @return The name of the element - */ - public String getName(){ - return name; - } - - /** - * Get the scope of the search operation - * @return The scope - defined in BugzillaMylarSearch - */ - public int getScope() { - return scope; - } -}
\ No newline at end of file |