forked from iipc/openwayback
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pull up fields and methods related to urlkey calculation from AccessP…
…oint to new AccessPointBase class, so that it can be reused in other RequestHandler implementations.
- Loading branch information
Showing
2 changed files
with
142 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
wayback-core/src/main/java/org/archive/wayback/webapp/AccessPointBase.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| /* | ||
| * This file is part of the Wayback archival access software | ||
| * (http://archive-access.sourceforge.net/projects/wayback/). | ||
| * | ||
| * Licensed to the Internet Archive (IA) by one or more individual | ||
| * contributors. | ||
| * | ||
| * The IA licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.archive.wayback.webapp; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| import org.archive.wayback.UrlCanonicalizer; | ||
| import org.archive.wayback.core.CaptureSearchResult; | ||
| import org.archive.wayback.core.Resource; | ||
| import org.archive.wayback.core.WaybackRequest; | ||
| import org.archive.wayback.util.url.UrlOperations; | ||
| import org.archive.wayback.util.webapp.AbstractRequestHandler; | ||
|
|
||
| /** | ||
| * AccessPointBase provides fields and methods common to AbstractRequestHandler | ||
| * implementations for core wayback machine functionalities (playback, search, | ||
| * live web archiving, etc.) | ||
| */ | ||
| public abstract class AccessPointBase extends AbstractRequestHandler { | ||
|
|
||
| private boolean exactSchemeMatch = false; | ||
| private UrlCanonicalizer selfRedirectCanonicalizer = null; | ||
|
|
||
| protected boolean isSelfRedirect(Resource resource, | ||
| CaptureSearchResult closest, WaybackRequest wbRequest, | ||
| String canonRequestURL) { | ||
| int status = resource.getStatusCode(); | ||
|
|
||
| // Only applies to redirects | ||
| if ((status < 300) || (status >= 400)) { | ||
| return false; | ||
| } | ||
|
|
||
| String location = resource.getHeader("Location"); | ||
|
|
||
| if (location == null) { | ||
| return false; | ||
| } | ||
|
|
||
| // if (!closest.getCaptureTimestamp().equals(wbRequest.getReplayTimestamp())) { | ||
| // return false; | ||
| // } | ||
|
|
||
| String redirScheme = UrlOperations.urlToScheme(location); | ||
|
|
||
| try { | ||
| if (redirScheme == null && isExactSchemeMatch()) { | ||
| location = UrlOperations.resolveUrl(closest.getOriginalUrl(), | ||
| location); | ||
| redirScheme = UrlOperations.urlToScheme(location); | ||
| } else if (location.startsWith("/")) { | ||
| location = UrlOperations.resolveUrl(closest.getOriginalUrl(), | ||
| location); | ||
| } | ||
|
|
||
| if (getSelfRedirectCanonicalizer() != null) { | ||
| location = getSelfRedirectCanonicalizer().urlStringToKey( | ||
| location); | ||
| } | ||
| } catch (IOException e) { | ||
| return false; | ||
| } | ||
|
|
||
| if (location.equals(canonRequestURL)) { | ||
| // if not exact scheme, don't do scheme compare, must be equal | ||
| if (!isExactSchemeMatch()) { | ||
| return true; | ||
| } | ||
|
|
||
| String origScheme = UrlOperations.urlToScheme(wbRequest | ||
| .getRequestUrl()); | ||
|
|
||
| if ((origScheme != null) && (redirScheme != null) && | ||
| (origScheme.compareTo(redirScheme) == 0)) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * @return the exactSchemeMatch | ||
| */ | ||
| public boolean isExactSchemeMatch() { | ||
| return exactSchemeMatch; | ||
| } | ||
|
|
||
| /** | ||
| * @param exactSchemeMatch the exactSchemeMatch to set | ||
| */ | ||
| public void setExactSchemeMatch(boolean exactSchemeMatch) { | ||
| this.exactSchemeMatch = exactSchemeMatch; | ||
| } | ||
|
|
||
| /** | ||
| * Optional | ||
| * @param selfRedirectCanonicalizer | ||
| */ | ||
| public void setSelfRedirectCanonicalizer(UrlCanonicalizer selfRedirectCanonicalizer) { | ||
| this.selfRedirectCanonicalizer = selfRedirectCanonicalizer; | ||
| } | ||
|
|
||
| /** | ||
| * URL canonicalizer for testing self-redirect. | ||
| * @return UrlCanonicalizer | ||
| */ | ||
| public UrlCanonicalizer getSelfRedirectCanonicalizer() { | ||
| return selfRedirectCanonicalizer; | ||
| } | ||
|
|
||
| protected String urlToKey(String url) { | ||
| if (selfRedirectCanonicalizer != null) { | ||
| try { | ||
| return selfRedirectCanonicalizer.urlStringToKey(url); | ||
| } catch (IOException ex) { | ||
| } | ||
| } | ||
| return url; | ||
| } | ||
| } |