100 lines
3.0 KiB
Java
100 lines
3.0 KiB
Java
package org.schabi.newpipe.extractor;
|
|
|
|
import edu.umd.cs.findbugs.annotations.NonNull;
|
|
import org.schabi.newpipe.extractor.exceptions.ExtractionException;
|
|
import org.schabi.newpipe.extractor.exceptions.ParsingException;
|
|
|
|
import javax.annotation.Nonnull;
|
|
import javax.annotation.Nullable;
|
|
import java.io.IOException;
|
|
|
|
public abstract class Extractor {
|
|
/**
|
|
* {@link StreamingService} currently related to this extractor.<br>
|
|
* Useful for getting other things from a service (like the url handlers for cleaning/accepting/get id from urls).
|
|
*/
|
|
private final StreamingService service;
|
|
|
|
private final UrlIdHandler urlIdHandler;
|
|
|
|
@Nullable
|
|
private boolean pageFetched = false;
|
|
private final Downloader downloader;
|
|
|
|
public Extractor(final StreamingService service, final UrlIdHandler urlIdHandler) {
|
|
if(service == null) throw new NullPointerException("service is null");
|
|
if(urlIdHandler == null) throw new NullPointerException("UrlIdHandler is null");
|
|
this.service = service;
|
|
this.urlIdHandler = urlIdHandler;
|
|
this.downloader = NewPipe.getDownloader();
|
|
if(downloader == null) throw new NullPointerException("downloader is null");
|
|
}
|
|
|
|
/**
|
|
* @return The {@link UrlIdHandler} of the current extractor object (e.g. a ChannelExtractor should return a channel url handler).
|
|
*/
|
|
@Nonnull
|
|
protected UrlIdHandler getUrlIdHandler() {
|
|
return urlIdHandler;
|
|
}
|
|
|
|
/**
|
|
* Fetch the current page.
|
|
* @throws IOException if the page can not be loaded
|
|
* @throws ExtractionException if the pages content is not understood
|
|
*/
|
|
public void fetchPage() throws IOException, ExtractionException {
|
|
if(pageFetched) return;
|
|
onFetchPage(downloader);
|
|
pageFetched = true;
|
|
}
|
|
|
|
protected void assertPageFetched() {
|
|
if(!pageFetched) throw new IllegalStateException("Page is not fetched. Make sure you call fetchPage()");
|
|
}
|
|
|
|
protected boolean isPageFetched() {
|
|
return pageFetched;
|
|
}
|
|
|
|
/**
|
|
* Fetch the current page.
|
|
* @param downloader the download to use
|
|
* @throws IOException if the page can not be loaded
|
|
* @throws ExtractionException if the pages content is not understood
|
|
*/
|
|
public abstract void onFetchPage(@Nonnull Downloader downloader) throws IOException, ExtractionException;
|
|
|
|
@Nonnull
|
|
public String getId() throws ParsingException {
|
|
return urlIdHandler.getId();
|
|
}
|
|
|
|
/**
|
|
* Get the name
|
|
* @return the name
|
|
* @throws ParsingException if the name cannot be extracted
|
|
*/
|
|
@Nonnull
|
|
public abstract String getName() throws ParsingException;
|
|
|
|
@Nonnull
|
|
public String getOriginalUrl() throws ParsingException {
|
|
return urlIdHandler.getOriginalUrl();
|
|
}
|
|
|
|
@Nonnull
|
|
public String getUrl() throws ParsingException {
|
|
return urlIdHandler.getUrl();
|
|
}
|
|
|
|
@Nonnull
|
|
public StreamingService getService() {
|
|
return service;
|
|
}
|
|
|
|
public int getServiceId() {
|
|
return service.getServiceId();
|
|
}
|
|
}
|