X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Flibrary%2FBasicLibrary.java;h=d435f8d7ec7fd3e2f09242339eefb9ff6fa74d93;hb=8831d290121e3a77f535ce06d61968a26ccf172a;hp=328ef656e444fbe4686dca82e08fafa204590d0d;hpb=99ccbdf63b539f1f40e070f5833f2d15fcf79830;p=fanfix.git
diff --git a/src/be/nikiroo/fanfix/library/BasicLibrary.java b/src/be/nikiroo/fanfix/library/BasicLibrary.java
deleted file mode 100644
index 328ef65..0000000
--- a/src/be/nikiroo/fanfix/library/BasicLibrary.java
+++ /dev/null
@@ -1,565 +0,0 @@
-package be.nikiroo.fanfix.library;
-
-import java.awt.image.BufferedImage;
-import java.io.File;
-import java.io.IOException;
-import java.net.URL;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-
-import be.nikiroo.fanfix.Instance;
-import be.nikiroo.fanfix.data.MetaData;
-import be.nikiroo.fanfix.data.Story;
-import be.nikiroo.fanfix.output.BasicOutput;
-import be.nikiroo.fanfix.output.BasicOutput.OutputType;
-import be.nikiroo.fanfix.supported.BasicSupport;
-import be.nikiroo.fanfix.supported.BasicSupport.SupportType;
-import be.nikiroo.utils.Progress;
-
-/**
- * Manage a library of Stories: import, export, list, modify.
- *
- * Each {@link Story} object will be associated with a (local to the library)
- * unique ID, the LUID, which will be used to identify the {@link Story}.
- *
- * Most of the {@link BasicLibrary} functions work on a partial (cover
- * MAY not be included) {@link MetaData} object.
- *
- * @author niki
- */
-abstract public class BasicLibrary {
- /**
- * Return a name for this library (the UI may display this).
- *
- * Must not be NULL.
- *
- * @return the name, or an empty {@link String} if none
- */
- public String getLibraryName() {
- return "";
- }
-
- /**
- * Retrieve the main {@link File} corresponding to the given {@link Story},
- * which can be passed to an external reader or instance.
- *
- * Do NOT alter this file.
- *
- * @param luid
- * the Library UID of the story
- *
- * @return the corresponding {@link Story}
- */
- public abstract File getFile(String luid);
-
- /**
- * Return the cover image associated to this story.
- *
- * @param luid
- * the Library UID of the story
- *
- * @return the cover image
- */
- public abstract BufferedImage getCover(String luid);
-
- /**
- * Return the cover image associated to this source.
- *
- * By default, return the cover of the first story with this source.
- *
- * @param source
- * the source
- *
- * @return the cover image or NULL
- */
- public BufferedImage getSourceCover(String source) {
- List metas = getListBySource(source);
- if (metas.size() > 0) {
- return getCover(metas.get(0).getLuid());
- }
-
- return null;
- }
-
- /**
- * Fix the source cover to the given story cover.
- *
- * @param source
- * the source to change
- * @param luid
- * the story LUID
- */
- public abstract void setSourceCover(String source, String luid);
-
- /**
- * Return the list of stories (represented by their {@link MetaData}, which
- * MAY not have the cover included).
- *
- * @param pg
- * the optional {@link Progress}
- *
- * @return the list (can be empty but not NULL)
- */
- protected abstract List getMetas(Progress pg);
-
- /**
- * Invalidate the {@link Story} cache (when the content should be re-read
- * because it was changed).
- */
- protected abstract void clearCache();
-
- /**
- * Return the next LUID that can be used.
- *
- * @return the next luid
- */
- protected abstract int getNextId();
-
- /**
- * Delete the target {@link Story}.
- *
- * @param luid
- * the LUID of the {@link Story}
- *
- * @throws IOException
- * in case of I/O error or if the {@link Story} wa not found
- */
- protected abstract void doDelete(String luid) throws IOException;
-
- /**
- * Actually save the story to the back-end.
- *
- * @param story
- * the {@link Story} to save
- * @param pg
- * the optional {@link Progress}
- *
- * @return the saved {@link Story} (which may have changed, especially
- * regarding the {@link MetaData})
- *
- * @throws IOException
- * in case of I/O error
- */
- protected abstract Story doSave(Story story, Progress pg)
- throws IOException;
-
- /**
- * Refresh the {@link BasicLibrary}, that is, make sure all stories are
- * loaded.
- *
- * @param full
- * force the full content of the stories to be loaded, not just
- * the {@link MetaData}
- *
- * @param pg
- * the optional progress reporter
- */
- public void refresh(boolean full, Progress pg) {
- if (full) {
- // TODO: progress
- List metas = getMetas(pg);
- for (MetaData meta : metas) {
- getStory(meta.getLuid(), null);
- }
- } else {
- getMetas(pg);
- }
- }
-
- /**
- * List all the known types (sources) of stories.
- *
- * @return the sources
- */
- public synchronized List getSources() {
- List list = new ArrayList();
- for (MetaData meta : getMetas(null)) {
- String storySource = meta.getSource();
- if (!list.contains(storySource)) {
- list.add(storySource);
- }
- }
-
- Collections.sort(list);
- return list;
- }
-
- /**
- * List all the known authors of stories.
- *
- * @return the authors
- */
- public synchronized List getAuthors() {
- List list = new ArrayList();
- for (MetaData meta : getMetas(null)) {
- String storyAuthor = meta.getAuthor();
- if (!list.contains(storyAuthor)) {
- list.add(storyAuthor);
- }
- }
-
- Collections.sort(list);
- return list;
- }
-
- /**
- * List all the stories in the {@link BasicLibrary}.
- *
- * Cover images not included.
- *
- * @return the stories
- */
- public synchronized List getList() {
- return getMetas(null);
- }
-
- /**
- * List all the stories of the given source type in the {@link BasicLibrary}
- * , or all the stories if NULL is passed as a type.
- *
- * Cover images not included.
- *
- * @param type
- * the type of story to retrieve, or NULL for all
- *
- * @return the stories
- */
- public synchronized List getListBySource(String type) {
- List list = new ArrayList();
- for (MetaData meta : getMetas(null)) {
- String storyType = meta.getSource();
- if (type == null || type.equalsIgnoreCase(storyType)) {
- list.add(meta);
- }
- }
-
- Collections.sort(list);
- return list;
- }
-
- /**
- * List all the stories of the given author in the {@link BasicLibrary}, or
- * all the stories if NULL is passed as an author.
- *
- * Cover images not included.
- *
- * @param author
- * the author of the stories to retrieve, or NULL for all
- *
- * @return the stories
- */
- public synchronized List getListByAuthor(String author) {
- List list = new ArrayList();
- for (MetaData meta : getMetas(null)) {
- String storyAuthor = meta.getAuthor();
- if (author == null || author.equalsIgnoreCase(storyAuthor)) {
- list.add(meta);
- }
- }
-
- Collections.sort(list);
- return list;
- }
-
- /**
- * Retrieve a {@link MetaData} corresponding to the given {@link Story},
- * cover image MAY not be included.
- *
- * @param luid
- * the Library UID of the story
- *
- * @return the corresponding {@link Story}
- */
- public synchronized MetaData getInfo(String luid) {
- if (luid != null) {
- for (MetaData meta : getMetas(null)) {
- if (luid.equals(meta.getLuid())) {
- return meta;
- }
- }
- }
-
- return null;
- }
-
- /**
- * Retrieve a specific {@link Story}.
- *
- * @param luid
- * the Library UID of the story
- * @param pg
- * the optional progress reporter
- *
- * @return the corresponding {@link Story} or NULL if not found
- */
- public synchronized Story getStory(String luid, Progress pg) {
- // TODO: pg
- if (pg == null) {
- pg = new Progress();
- }
-
- Story story = null;
- for (MetaData meta : getMetas(null)) {
- if (meta.getLuid().equals(luid)) {
- File file = getFile(luid);
- try {
- SupportType type = SupportType.valueOfAllOkUC(meta
- .getType());
- URL url = file.toURI().toURL();
- if (type != null) {
- story = BasicSupport.getSupport(type).process(url, pg);
- } else {
- throw new IOException("Unknown type: " + meta.getType());
- }
- } catch (IOException e) {
- // We should not have not-supported files in the
- // library
- Instance.syserr(new IOException(
- "Cannot load file from library: " + file, e));
- } finally {
- pg.done();
- }
-
- break;
- }
- }
-
- return story;
- }
-
- /**
- * Import the {@link Story} at the given {@link URL} into the
- * {@link BasicLibrary}.
- *
- * @param url
- * the {@link URL} to import
- * @param pg
- * the optional progress reporter
- *
- * @return the imported {@link Story}
- *
- * @throws IOException
- * in case of I/O error
- */
- public Story imprt(URL url, Progress pg) throws IOException {
- BasicSupport support = BasicSupport.getSupport(url);
- if (support == null) {
- throw new IOException("URL not supported: " + url.toString());
- }
-
- return save(support.process(url, pg), null);
- }
-
- /**
- * Import the story from one library to another, and keep the same LUID.
- *
- * @param other
- * the other library to import from
- * @param luid
- * the Library UID
- * @param pg
- * the optional progress reporter
- *
- * @throws IOException
- * in case of I/O error
- */
- public void imprt(BasicLibrary other, String luid, Progress pg)
- throws IOException {
- Progress pgGetStory = new Progress();
- Progress pgSave = new Progress();
- if (pg == null) {
- pg = new Progress();
- }
-
- pg.setMinMax(0, 2);
- pg.addProgress(pgGetStory, 1);
- pg.addProgress(pgSave, 1);
-
- Story story = other.getStory(luid, pgGetStory);
- if (story != null) {
- story = this.save(story, luid, pgSave);
- pg.done();
- } else {
- pg.done();
- throw new IOException("Cannot find story in Library: " + luid);
- }
- }
-
- /**
- * Export the {@link Story} to the given target in the given format.
- *
- * @param luid
- * the {@link Story} ID
- * @param type
- * the {@link OutputType} to transform it to
- * @param target
- * the target to save to
- * @param pg
- * the optional progress reporter
- *
- * @return the saved resource (the main saved {@link File})
- *
- * @throws IOException
- * in case of I/O error
- */
- public File export(String luid, OutputType type, String target, Progress pg)
- throws IOException {
- Progress pgGetStory = new Progress();
- Progress pgOut = new Progress();
- if (pg != null) {
- pg.setMax(2);
- pg.addProgress(pgGetStory, 1);
- pg.addProgress(pgOut, 1);
- }
-
- BasicOutput out = BasicOutput.getOutput(type, false);
- if (out == null) {
- throw new IOException("Output type not supported: " + type);
- }
-
- Story story = getStory(luid, pgGetStory);
- if (story == null) {
- throw new IOException("Cannot find story to export: " + luid);
- }
-
- return out.process(story, target, pgOut);
- }
-
- /**
- * Save a {@link Story} to the {@link BasicLibrary}.
- *
- * @param story
- * the {@link Story} to save
- * @param pg
- * the optional progress reporter
- *
- * @return the same {@link Story}, whose LUID may have changed
- *
- * @throws IOException
- * in case of I/O error
- */
- public Story save(Story story, Progress pg) throws IOException {
- return save(story, null, pg);
- }
-
- /**
- * Save a {@link Story} to the {@link BasicLibrary} -- the LUID must
- * be correct, or NULL to get the next free one.
- *
- * Will override any previous {@link Story} with the same LUID.
- *
- * @param story
- * the {@link Story} to save
- * @param luid
- * the correct LUID or NULL to get the next free one
- * @param pg
- * the optional progress reporter
- *
- * @return the same {@link Story}, whose LUID may have changed
- *
- * @throws IOException
- * in case of I/O error
- */
- public synchronized Story save(Story story, String luid, Progress pg)
- throws IOException {
- // Do not change the original metadata, but change the original story
- MetaData meta = story.getMeta().clone();
- story.setMeta(meta);
-
- if (luid == null || luid.isEmpty()) {
- meta.setLuid(String.format("%03d", getNextId()));
- } else {
- meta.setLuid(luid);
- }
-
- if (getInfo(luid) != null) {
- delete(luid);
- }
-
- doSave(story, pg);
-
- clearCache();
-
- return story;
- }
-
- /**
- * Delete the given {@link Story} from this {@link BasicLibrary}.
- *
- * @param luid
- * the LUID of the target {@link Story}
- *
- * @throws IOException
- * in case of I/O error
- */
- public synchronized void delete(String luid) throws IOException {
- doDelete(luid);
- clearCache();
- }
-
- /**
- * Change the type (source) of the given {@link Story}.
- *
- * @param luid
- * the {@link Story} LUID
- * @param newSource
- * the new source
- * @param pg
- * the optional progress reporter
- *
- * @throws IOException
- * in case of I/O error or if the {@link Story} was not found
- */
- public synchronized void changeSource(String luid, String newSource,
- Progress pg) throws IOException {
- MetaData meta = getInfo(luid);
- if (meta == null) {
- throw new IOException("Story not found: " + luid);
- }
-
- meta.setSource(newSource);
- saveMeta(meta, pg);
- }
-
- /**
- * Save back the current state of the {@link MetaData} (LUID MUST NOT
- * change) for this {@link Story}.
- *
- * By default, delete the old {@link Story} then recreate a new
- * {@link Story}.
- *
- * Note that this behaviour can lead to data loss.
- *
- * @param meta
- * the new {@link MetaData} (LUID MUST NOT change)
- * @param pg
- * the optional {@link Progress}
- *
- * @throws IOException
- * in case of I/O error or if the {@link Story} was not found
- */
- protected synchronized void saveMeta(MetaData meta, Progress pg)
- throws IOException {
- if (pg == null) {
- pg = new Progress();
- }
-
- Progress pgGet = new Progress();
- Progress pgSet = new Progress();
- pg.addProgress(pgGet, 50);
- pg.addProgress(pgSet, 50);
-
- Story story = getStory(meta.getLuid(), pgGet);
- if (story == null) {
- throw new IOException("Story not found: " + meta.getLuid());
- }
-
- delete(meta.getLuid());
-
- story.setMeta(meta);
- save(story, meta.getLuid(), pgSet);
-
- pg.done();
- }
-}