PageControl.java

package net.bible.android.control.page;

import android.app.Activity;
import android.content.Intent;
import android.content.SharedPreferences;
import android.text.ClipboardManager;
import android.util.Log;

import net.bible.android.BibleApplication;
import net.bible.android.activity.R;
import net.bible.android.control.ApplicationScope;
import net.bible.android.control.document.DocumentControl;
import net.bible.android.control.page.window.ActiveWindowPageManagerProvider;
import net.bible.android.control.page.window.Window;
import net.bible.android.control.versification.Scripture;
import net.bible.android.view.activity.base.CurrentActivityHolder;
import net.bible.android.view.activity.base.Dialogs;
import net.bible.service.common.ABStringUtils;
import net.bible.service.common.CommonUtils;
import net.bible.service.common.TitleSplitter;
import net.bible.service.font.FontControl;
import net.bible.service.sword.SwordContentFacade;
import net.bible.service.sword.SwordDocumentFacade;

import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.text.WordUtils;
import org.crosswire.jsword.book.Book;
import org.crosswire.jsword.passage.Key;
import org.crosswire.jsword.passage.Verse;
import org.crosswire.jsword.passage.VerseRange;
import org.crosswire.jsword.versification.BibleBook;
import org.crosswire.jsword.versification.Versification;

import java.util.List;

import javax.inject.Inject;

/**
 * SesionFacade for CurrentPage used by View classes
 * @author Martin Denham [mjdenham at gmail dot com]
 * @see gnu.lgpl.License for license details.<br>
 *      The copyright to this program is held by it's author.
 */
@ApplicationScope
public class PageControl {
	
	private static final String TAG = "PageControl";
	
	private static final TitleSplitter titleSplitter = new TitleSplitter();

	private final  SwordDocumentFacade swordDocumentFacade;
	private final SwordContentFacade swordContentFacade;

	private final DocumentControl documentControl;

	private final ActiveWindowPageManagerProvider activeWindowPageManagerProvider;

	@Inject
	public PageControl(SwordDocumentFacade swordDocumentFacade, SwordContentFacade swordContentFacade, DocumentControl documentControl, ActiveWindowPageManagerProvider activeWindowPageManagerProvider) {
		this.swordDocumentFacade = swordDocumentFacade;
		this.swordContentFacade = swordContentFacade;
		this.documentControl = documentControl;
		this.activeWindowPageManagerProvider = activeWindowPageManagerProvider;
	}

	/** Paste the current verse to the system clipboard
	 */
	public void copyToClipboard(VerseRange verseRange) {
		try {
			Book book = getCurrentPageManager().getCurrentPage().getCurrentDocument();

			String text = verseRange.getName()+"\n"+swordContentFacade.getCanonicalText(book, verseRange);
			ClipboardManager clipboard = (ClipboardManager)BibleApplication.getApplication().getSystemService(Activity.CLIPBOARD_SERVICE);
			clipboard.setText(text);
		} catch (Exception e) {
			Log.e(TAG, "Error pasting to clipboard", e);
			Dialogs.getInstance().showErrorMsg("Error copying to clipboard");
		}
	}

	/** send the current verse via social applications installed on user's device
	 */
	public void shareVerse(VerseRange verseRange) {
		try {
			Book book = getCurrentPageManager().getCurrentPage().getCurrentDocument();

			String text = verseRange.getName()+"\n"+swordContentFacade.getCanonicalText(book, verseRange);
			
			Intent sendIntent  = new Intent(Intent.ACTION_SEND);
			sendIntent.setType("text/plain");

			sendIntent.putExtra(Intent.EXTRA_TEXT, text);
			// subject is used when user chooses to send verse via e-mail
			sendIntent.putExtra(Intent.EXTRA_SUBJECT, BibleApplication.getApplication().getText(R.string.share_verse_subject));

			Activity activity = CurrentActivityHolder.getInstance().getCurrentActivity();
			activity.startActivity(Intent.createChooser(sendIntent, activity.getString(R.string.share_verse))); 
			
		} catch (Exception e) {
			Log.e(TAG, "Error sharing verse", e);
			Dialogs.getInstance().showErrorMsg("Error sharing verse");
		}
	}
	
	/** This is only called after the very first bible download to attempt to ensure the first page is not 'Verse not found' 
	 * go through a list of default verses until one is found in the first/only book installed
	 */
	public void setFirstUseDefaultVerse() {
		try {
			Versification versification = getCurrentPageManager().getCurrentBible().getVersification();
			Verse[] defaultVerses = new Verse[] {
					new Verse(versification, BibleBook.JOHN,3,16),
					new Verse(versification, BibleBook.GEN,1,1),
					new Verse(versification, BibleBook.PS,1,1)};
	    	List<Book> bibles = swordDocumentFacade.getBibles();
	        if (bibles.size()==1) {
	        	Book bible = bibles.get(0);
	        	for (Verse verse : defaultVerses) {
		        	if (bible.contains(verse)) {
		        		getCurrentPageManager().getCurrentBible().setKey(verse);
		        		return;
		        	}
	        	}
	        }
			
		} catch (Exception e) {
			Log.e(TAG, "Verse error");
		}
	}
	/** 
	 * Get page title including info about current doc
	 * Return it in 1 or 2 parts allowing it to be split over 2 lines
	 */
	public String[] getCurrentDocumentTitleParts() {
	
		String title = "";
		CurrentPage currentPage = getCurrentPageManager().getCurrentPage();
		if (currentPage!=null) {
			if (currentPage.getCurrentDocument()!=null) {
				title = currentPage.getCurrentDocument().getAbbreviation();
			}
		}
		
		String[] parts = titleSplitter.split(title);
		if (parts.length>2) {
			// skip first element which is often the language or book type e.g. GerNeUe, StrongsRealGreek
			parts = ArrayUtils.subarray(parts, 1, 3);
		}

		return parts;
	}

	/** 
	 * Get page title including info about key/verse
	 * Return it in 1 or 2 parts allowing it to be split over 2 lines
	 */
	public String[] getCurrentPageTitleParts() {
		String[] retVal=new String[2];
		try {
			CurrentPage currentPage = getCurrentPageManager().getCurrentPage();
			if (currentPage!=null) {
				if (currentPage.getSingleKey()!=null) {
					Key key = currentPage.getSingleKey();
					// verses are special - show book at top and verse below
					if (key instanceof Verse) {
						Verse verse = (Verse)key;
						Versification v11n = verse.getVersification();
						retVal[0] = StringUtils.left(v11n.getShortName(verse.getBook()), 6);
						
						StringBuilder verseText = new StringBuilder();
						verseText.append(verse.getChapter());
						int verseNo = verse.getVerse();
						if (verseNo>0) {
							verseText.append(":").append(verseNo);
						}
						retVal[1] = verseText.toString();
					} else {
						// handle all non verse keys in a generic way
						String title = key.getName();
						// favour correct capitalisation because it looks better and is narrower so more fits in
						if (ABStringUtils.isAllUpperCaseWherePossible(title)) {
							// Books like INSTITUTES need corrected capitalisation
							title = WordUtils.capitalizeFully(title);
						}
						String[] parts = titleSplitter.split(title);
						retVal = ArrayUtils.subarray(parts, 0, 2);
					}
				}
			}
		} catch (Exception e) {
			Log.e(TAG, "Error getting page title", e);
		}
		return retVal;
	}

	public Verse getCurrentBibleVerse() {
		return getCurrentPageManager().getCurrentBible().getSingleKey();
	}
	
	/** font size may be adjusted for certain fonts e.g. SBLGNT
	 */
	public int getDocumentFontSize(Window window) {
		// get base font size
		SharedPreferences preferences = CommonUtils.getSharedPreferences();
		int fontSize = preferences.getInt("text_size_pref", 16);

		// if book has a special font it may require an adjusted font size
		Book book = window.getPageManager().getCurrentPage().getCurrentDocument();
		String font = FontControl.getInstance().getFontForBook(book);
		int fontSizeAdjustment = FontControl.getInstance().getFontSizeAdjustment(font, book);
		
		return fontSize+fontSizeAdjustment;		
	}
	
	/** return true if Strongs numbers are shown */
	public boolean isStrongsShown() {
		return isStrongsRelevant() &&
			   CommonUtils.getSharedPreferences().getBoolean("show_strongs_pref", true);
	}

	/** return true if Strongs are relevant to this doc & screen */
	public boolean isStrongsRelevant() {

		return documentControl.isStrongsInBook();
	}

	/**
	 * Return false if current page is not scripture, but only if the page is valid
	 */
	public boolean isCurrentPageScripture() {
		VersePage currentVersePage = getCurrentPageManager().getCurrentVersePage();
		Versification currentVersification = currentVersePage.getVersification();
		BibleBook currentBibleBook = currentVersePage.getCurrentBibleVerse().getCurrentBibleBook();
		boolean isCurrentBibleBookScripture = Scripture.isScripture(currentBibleBook);

		// Non-scriptural pages are not so safe.  They may be synched with the other screen but not support the current dc book 
		return isCurrentBibleBookScripture ||
				!currentVersification.containsBook(currentBibleBook);
	}
	
	public CurrentPageManager getCurrentPageManager() {
		return activeWindowPageManagerProvider.getActiveWindowPageManager();
	}
}