Package org.opengrok.web

Class PageConfig

java.lang.Object
org.opengrok.web.PageConfig
public class PageConfig extends Object
A simple container to lazy initialize common vars wrt. a single request. It MUST NOT be shared between several requests and cleanup(ServletRequest) should be called before the page context gets destroyed (e.g.when leaving the service method).

Purpose is to decouple implementation details from web design, so that the JSP developer does not need to know every implementation detail and normally has to deal with this class/wrapper, only (so some people may like to call this class a bean with request scope ;-)). Furthermore, it helps to keep the pages (how content gets generated) consistent and to document the request parameters used.

General contract for this class (i.e. if not explicitly documented): no method of this class changes neither the request nor the response.

Author:
Jens Elkner

  • Field Details

  • Method Details

    • setRequestAttribute

      public void setRequestAttribute(String attr, Object val)
      Sets current request's attribute.
      Parameters:
      attr - attribute
      val - value

    • getRequestAttribute

      public Object getRequestAttribute(String attr)
      Gets current request's attribute.
      Parameters:
      attr - attribute
      Returns:
      Object attribute value or null if attribute does not exist

    • getHistoryAttrName

      public String getHistoryAttrName()
      Returns:
      name of the JSP attribute to store the History object.

    • removeAttribute

      public void removeAttribute(String string)
      Removes an attribute from the current request.
      Parameters:
      string - the attribute

    • addHeaderData

      public void addHeaderData(String data)
      Add the given data to the <head> section of the html page to generate.
      Parameters:
      data - data to add. It is copied as is, so remember to escape special characters ...

    • getHeaderData

      public String getHeaderData()
      Get addition data, which should be added as is to the <head> section of the HTML page.
      Returns:
      an empty string if nothing to add, the data otherwise.

    • getDiffData

      public DiffData getDiffData()
      Get all data required to create a diff view w.r.t. to this request in one go.
      Returns:
      an instance with just enough information to render a sufficient view. If not all required parameters were given either they are supplemented with reasonable defaults if possible, otherwise the related field(s) are null. DiffData.errorMsg != null indicates that an error occurred and one should not try to render a view.

    • getDiffType

      public DiffType getDiffType()
      Get the diff display type to use wrt. the request parameter format.
      Returns:
      DiffType.SIDEBYSIDE if the request contains no such parameter or one with an unknown value, the recognized diff type otherwise.
      See Also:

    • fullDiff

      public boolean fullDiff()
      Check, whether a full diff should be displayed.
      Returns:
      true if a request parameter full with the literal value 1 was found.

    • canProcess

      public String canProcess()
      Check, whether the request contains minimal information required to produce a valid page. If this method returns an empty string, the referred file or directory actually exists below the source root directory and is readable.
      Returns:
      null if the referred src file, directory or history is not available, an empty String if further processing is ok and a non-empty string which contains the URI encoded redirect path if the request should be redirected.
      See Also:

    • getResourceFileList

      public List<String> getResourceFileList()
      Get a list of filenames in the requested path.
      Returns:
      an empty list, if the resource does not exist, is not a directory or an error occurred when reading it, otherwise a list of filenames in that directory, sorted alphabetically

      For the root directory (/xref/), authorization check is performed for each project in case that projects are used.

      See Also:

    • getSortedFiles

      @VisibleForTesting public static List<String> getSortedFiles(File[] files)

    • getLastModified

      public long getLastModified()
      Returns:
      the last modification time of the related file or directory.
      See Also:

    • getHistoryDirs

      public String getHistoryDirs()
      Get all RSS related directories from the request using its also parameter.
      Returns:
      an empty string if the requested resource is not a directory, a space (' ') separated list of unchecked directory names otherwise.

    • getIntParam

      public int getIntParam(String name, int defaultValue)
      Get the integer value of the given request parameter.
      Parameters:
      name - name of the parameter to lookup.
      defaultValue - value to return, if the parameter is not set, is not a number, or is < 0.
      Returns:
      the parsed integer value on success, the given default value otherwise.

    • getStartIndex

      public int getStartIndex()
      Get the start index for a search result or history listing to return by looking up the start request parameter.
      Returns:
      0 if the corresponding start parameter is not set or not a number, the number found otherwise.

    • getMaxItems

      public int getMaxItems()
      Get the number of search results or history entries to display by looking up the n request parameter.
      Returns:
      the default number of items if the corresponding start parameter is not set or not a number, the number found otherwise.

    • getRevisionMessageCollapseThreshold

      public int getRevisionMessageCollapseThreshold()

    • getCurrentIndexedCollapseThreshold

      public int getCurrentIndexedCollapseThreshold()

    • getGroupsCollapseThreshold

      public int getGroupsCollapseThreshold()

    • getSortOrder

      public List<SortOrder> getSortOrder()
      Get sort orders from the request parameter sort and if this list would be empty from the cookie OpenGrokSorting.
      Returns:
      a possible empty list which contains the sort order values in the same order supplied by the request parameter or cookie(s).

    • getQueryBuilder

      public QueryBuilder getQueryBuilder()
      Get a reference to the QueryBuilder wrt. to the current request parameters:
      q
      freetext lookup rules
      defs
      definitions lookup rules
      path
      path related rules
      hist
      history related rules
      Returns:
      a query builder with all relevant fields populated.

    • getEftarReader

      public EftarFileReader getEftarReader()
      Get the Eftar reader for the data directory. If it has been already opened and not closed, this instance gets returned. One should not close it once used: cleanup(ServletRequest) takes care to close it.
      Returns:
      null if a reader can't be established, the reader otherwise.

    • getDefineTagsIndex

      public String getDefineTagsIndex()
      Get the definition tag for the request related file or directory.
      Returns:
      an empty string if not found, the tag otherwise.

    • getRequestedRevision

      public String getRequestedRevision()
      Get the revision parameter r from the request.
      Returns:
      revision if found, an empty string otherwise.

    • hasHistory

      public boolean hasHistory()
      Check, whether the request related resource has history information.
      Returns:
      true if history is available.
      See Also:

    • hasAnnotations

      public boolean hasAnnotations()
      Returns:
      whether annotations are available for the related resource.

    • annotate

      public boolean annotate()
      Check, whether the resource to show should be annotated.
      Returns:
      true if annotation is desired and available.

    • getAnnotation

      public Annotation getAnnotation()
      Get the annotation for the requested resource.
      Returns:
      null if not available or annotation was not requested, the cached annotation otherwise.

    • getSearchOnlyIn

      public String[] getSearchOnlyIn()
      Get the path parameter and display value for "Search only in" option.
      Returns:
      always an array of 3 fields, whereby field[0] contains the path value to use (starts and ends always with a Indexer.PATH_SEPARATOR). Field[1] the contains string to show in the UI. field[2] is set to disabled="" if the current path is the "/" directory, otherwise set to an empty string.

    • getProject

      @Nullable public @Nullable Project getProject()
      Get the project getPath() refers to.
      Returns:
      null if not available, the project otherwise.

    • getRequestedProjectsAsString

      public String getRequestedProjectsAsString()
      Same as getRequestedProjects() but returns the project names as a coma separated String.
      Returns:
      a possible empty String but never null.

    • getRequestedProjects

      public SortedSet<String> getRequestedProjects()
      Get a reference to a set of requested projects via request parameter project or cookies or defaults.

      NOTE: This method assumes, that project names do not contain a comma (','), since this character is used as name separator!

      It is determined as follows:

      1. If there is no project in the configuration an empty set is returned. Otherwise:
      2. If there is only one project in the configuration, this one gets returned (no matter, what the request actually says). Otherwise
      3. If the request parameter ALL_PROJECT_SEARCH contains a true value, all projects are added to searching. Otherwise:
      4. If the request parameter PROJECT_PARAM_NAME contains any available project, the set with invalid projects removed gets returned. Otherwise:
      5. If the request parameter GROUP_PARAM_NAME contains any available group, then all projects from that group will be added to the result set. Otherwise:
      6. If the request has a cookie with the name OPEN_GROK_PROJECT and it contains any available project, the set with invalid projects removed gets returned. Otherwise:
      7. If a default project is set in the configuration, this project gets returned. Otherwise:
      8. an empty set
      Returns:
      a possible empty set of project names but never null.
      See Also:

    • getCookieVals

      public List<String> getCookieVals(String cookieName)
      Get the cookie values for the given name. Splits comma separated values automatically into a list of Strings.
      Parameters:
      cookieName - name of the cookie.
      Returns:
      a possible empty list.

    • getProjectHelper

      public ProjectHelper getProjectHelper()

    • setTitle

      public void setTitle(String title)
      Set the page title to use.
      Parameters:
      title - title to set (might be null).

    • getTitle

      public String getTitle()
      Get the page title to use.
      Returns:
      null if not set, the page title otherwise.

    • getCssDir

      public String getCssDir()
      Get the base path to use to refer to CSS stylesheets and related resources. Usually used to create links.
      Returns:
      the appropriate application directory prefixed with the application's context path (e.g. "/source/default").
      See Also:

    • getEnv

      public RuntimeEnvironment getEnv()
      Get the current runtime environment.
      Returns:
      the runtime env.
      See Also:

    • getIgnoredNames

      public IgnoredNames getIgnoredNames()
      Get the name patterns used to determine, whether a file should be ignored.
      Returns:
      the corresponding value from the current runtime config..

    • getSourceRootPath

      public String getSourceRootPath()
      Get the canonical path to root of the source tree. File separators are replaced with a Indexer.PATH_SEPARATOR.
      Returns:
      The on disk source root directory.
      See Also:

    • getPrefix

      public Prefix getPrefix()
      Get the prefix for the related request.
      Returns:
      Prefix.UNKNOWN if the servlet path matches any known prefix, the prefix otherwise.

    • getPath

      public String getPath()
      Get the canonical path of the related resource relative to the source root directory (used file separators are all Indexer.PATH_SEPARATOR). No check is made, whether the obtained path is really an accessible resource on disk.

      Also, care needs to be taken when embedding the result in a page. Consider using Util.htmlize(String) or Util.uriEncodePath(String).

      Returns:
      a possible empty String (denotes the source root directory) but not null.
      See Also:
      • HttpServletRequest.getPathInfo()

    • isUnreadable

      public boolean isUnreadable()
      Returns:
      true if file/directory corresponding to the request path exists however is unreadable, false otherwise

    • getResourceFile

      public File getResourceFile(String path)
      Get the file object for the given path.

      NOTE: If a repository contains hard or symbolic links, the returned file may finally point to a file outside the source root directory.

      Parameters:
      path - the path to the file relatively to the source root
      Returns:
      null if the related file or directory is not available (can not be found below the source root directory), the readable file or directory otherwise.
      See Also:

    • getResourceFile

      public File getResourceFile()
      Get the on disk file to the request related file or directory.

      NOTE: If a repository contains hard or symbolic links, the returned file may finally point to a file outside the source root directory.

      Returns:
      new File({@link org.opengrok.indexer.index.Indexer#PATH_SEPARATOR_STRING }) if the related file or directory is not available (can not be find below the source root directory), the readable file or directory otherwise.
      See Also:

    • getResourcePath

      public String getResourcePath()
      Get the canonical on disk path to the request related file or directory with all file separators replaced by a Indexer.PATH_SEPARATOR.
      Returns:
      Indexer.PATH_SEPARATOR_STRING if the evaluated path is invalid or outside the source root directory, otherwise the path to the readable file or directory.
      See Also:

    • resourceNotAvailable

      public boolean resourceNotAvailable()
      Check, whether the related request resource matches a valid file or directory below the source root directory and whether it matches an ignored pattern.
      Returns:
      true if the related resource does not exist or should be ignored.
      See Also:

    • isDir

      public boolean isDir()
      Check, whether the request related path represents a directory.
      Returns:
      true if directory related request

    • findDataFiles

      public File[] findDataFiles(@Nullable @Nullable List<String> filenames)
      Find the files with the given names in the getPath() directory relative to the cross-file directory of the opengrok data directory. It will try to find the compressed file first by appending the file extension ".gz" to the filename. If that fails or an uncompressed version of the file is younger than its compressed version, the uncompressed file gets used.
      Parameters:
      filenames - filenames to lookup.
      Returns:
      an empty array if the related directory does not exist or the given list is null or empty, otherwise an array, which may contain null entries (when the related file could not be found) having the same order as the given list.

    • findDataFile

      public File findDataFile()
      Lookup the file getPath() relative to the cross-file directory of the opengrok data directory. It is tried to find the compressed file first by appending the file extension ".gz" to the filename. If that fails or an uncompressed version of the file is younger than its compressed version, the uncompressed file gets used.
      Returns:
      null if not found, the file otherwise.

    • isLatestRevision

      public boolean isLatestRevision(String rev)
      Is revision the latest revision ?
      Parameters:
      rev - revision string
      Returns:
      true if latest revision, false otherwise

    • getRevisionLocation

      public String getRevisionLocation(String revStr)
      Get the location of cross-reference for given file containing the given revision.
      Parameters:
      revStr - defined revision string
      Returns:
      location to redirect to

    • getDirectoryRedirect

      public String getDirectoryRedirect()
      Get the path the request should be redirected (if any).
      Returns:
      null if there is no reason to redirect, the URI encoded redirect path to use otherwise.

    • getUriEncodedPath

      public String getUriEncodedPath()
      Get the URI encoded canonical path to the related file or directory (the URI part between the servlet path and the start of the query string).
      Returns:
      a URI encoded path which might be an empty string but not null.
      See Also:

    • addScript

      public PageConfig addScript(String name)
      Add a new file script to the page by the name.
      Parameters:
      name - name of the script to search for
      Returns:
      this
      See Also:

    • getScripts

      public Scripts getScripts()
      Return the page scripts.
      Returns:
      the scripts
      See Also:

    • getDataRoot

      public File getDataRoot()
      Get opengrok's configured data root directory. It is verified, that the used environment has a valid opengrok data root set and that it is an accessible directory.
      Returns:
      the opengrok data directory.
      Throws:
      InvalidParameterException - if inaccessible or not set.

    • getServerName

      public String getServerName()
      Play nice in reverse proxy environment by using pre-configured hostname request to construct the URLs. Will not work well if the scheme or port is different for proxied server and original server.
      Returns:
      server name

    • prepareSearch

      public SearchHelper prepareSearch()
      Prepare a search helper with all required information, ready to execute the query implied by the related request parameters and cookies.

      NOTE: One should check the SearchHelper.getErrorMsg() as well as SearchHelper.getRedirect() and take the appropriate action before executing the prepared query or continue processing.

      This method stops populating fields as soon as an error occurs.

      Returns:
      a search helper.

    • prepareInternalSearch

      public SearchHelper prepareInternalSearch(SortOrder sortOrder)
      Prepare a search helper with required settings for an internal search.

      NOTE: One should check the SearchHelper.getErrorMsg() as well as SearchHelper.getRedirect() and take the appropriate action before executing the prepared query or continue processing.

      This method stops populating fields as soon as an error occurs.

      Parameters:
      sortOrder - instance of SortOrder
      Returns:
      a search helper.

    • getExtras

      @Nullable public @Nullable List<NullableNumLinesLOC> getExtras(@Nullable @Nullable Project project, jakarta.servlet.http.HttpServletRequest request) throws IOException
      Parameters:
      project - Project instance or null
      request - HTTP request
      Returns:
      list of NullableNumLinesLOC instances related to path
      Throws:
      IOException - on I/O error

    • getNullableNumLinesLOCS

      @Nullable @VisibleForTesting public @Nullable List<NullableNumLinesLOC> getNullableNumLinesLOCS(@Nullable @Nullable Project project, SearchHelper searchHelper) throws IOException
      Throws:
      IOException

    • get

      public static PageConfig get(jakarta.servlet.http.HttpServletRequest request)
      Get the config w.r.t. the given request. If there is none yet, a new config gets created, attached to the request and returned.

      Parameters:
      request - the request to use to initialize the config parameters.
      Returns:
      always the same none-null config for a given request.
      Throws:
      NullPointerException - if the given parameter is null.

    • get

      public static PageConfig get(String path, jakarta.servlet.http.HttpServletRequest request)

    • cleanup

      public static void cleanup(jakarta.servlet.ServletRequest sr)
      Cleanup all allocated resources (if any) from the instance attached to the given request.
      Parameters:
      sr - request to check, cleanup. Ignored if null.
      See Also:

    • isAllowed

      public boolean isAllowed(Project t)
      Checks if current request is allowed to access project.
      Parameters:
      t - project
      Returns:
      true if yes

    • isAllowed

      public boolean isAllowed(Group g)
      Checks if current request is allowed to access group.
      Parameters:
      g - group
      Returns:
      true if yes

    • getMessages

      public SortedSet<MessagesContainer.AcceptedMessage> getMessages()

    • getMessages

      public SortedSet<MessagesContainer.AcceptedMessage> getMessages(String tag)

    • getShortPath

      public String getShortPath(String path)
      Get basename of the path or "/" if the path is empty. This is used for setting title of various pages.
      Parameters:
      path - path
      Returns:
      short version of the path

    • getSearchTitle

      public String getSearchTitle()
      The search page title string should progressively reflect the search terms so that if only small portion of the string is seen, it describes the action as closely as possible while remaining readable.
      Returns:
      string used for setting page title of search results page

    • getHistoryTitle

      public String getHistoryTitle()
      Similar as getSearchTitle().
      Returns:
      string used for setting page title of search view

    • getPathTitle

      public String getPathTitle()
      Returns:
      page title string with base name of the path and optionally revision ID, HTML encoded

    • checkSourceRootExistence

      public void checkSourceRootExistence() throws IOException
      Throws:
      IOException

    • isNotModified

      public boolean isNotModified(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Decide if this resource has been modified since the header value in the request.

      The resource is modified since the weak ETag value in the request, the ETag is computed using:

      • the source file modification
      • project messages
      • last timestamp for index
      • OpenGrok current deployed version

      If the resource was modified, appropriate headers in the response are filled.

      Parameters:
      request - the http request containing the headers
      response - the http response for setting the headers
      Returns:
      true if resource was not modified; false otherwise
      See Also:

    • getRelativePath

      public static String getRelativePath(String root, String path)
      Parameters:
      root - root path
      path - path
      Returns:
      path relative to root

    • evaluateMatchOffset

      public boolean evaluateMatchOffset()
      Determines whether a match offset from a search result has been indicated, and if so tries to calculate a translated xref fragment identifier.
      Returns:
      true if a xref fragment identifier was calculated by the call to this method