CourseContentSyncTask.java

package in.co.praveenkumar.mdroid.task;

import in.co.praveenkumar.mdroid.model.MDroidNotification;
import in.co.praveenkumar.mdroid.model.MoodleCourse;
import in.co.praveenkumar.mdroid.model.MoodleModule;
import in.co.praveenkumar.mdroid.model.MoodleModuleContent;
import in.co.praveenkumar.mdroid.model.MoodleSection;
import in.co.praveenkumar.mdroid.moodlerest.MoodleRestCourseContent;

import java.util.ArrayList;
import java.util.List;

public class CourseContentSyncTask {
	String mUrl;
	String token;
	long siteid;

	MoodleCourse course;
	String error;
	Boolean notification;
	int notificationcount;

	/**
	 * 
	 * @param mUrl
	 * @param token
	 * @param siteid
	 * 
	 * @author Praveen Kumar Pendyala (praveen@praveenkumar.co.in)
	 */
	public CourseContentSyncTask(String mUrl, String token, long siteid) {
		this.mUrl = mUrl;
		this.token = token;
		this.siteid = siteid;
		this.notification = false;
		this.notificationcount = 0;
	}

	/**
	 * 
	 * @param mUrl
	 * @param token
	 * @param siteid
	 * @param notification
	 *            If true, sets notifications for new contents
	 * 
	 * @author Praveen Kumar Pendyala (praveen@praveenkumar.co.in)
	 */
	public CourseContentSyncTask(String mUrl, String token, long siteid,
			Boolean notification) {
		this.mUrl = mUrl;
		this.token = token;
		this.siteid = siteid;
		this.notification = notification;
		this.notificationcount = 0;
	}

	/**
	 * Get the notifications count. Notifications should be enabled during
	 * Object instantiation.
	 * 
	 * @return notificationcount
	 */
	public int getNotificationcount() {
		return notificationcount;
	}

	/**
	 * Sync all sections in a course in the current site. <br/>
	 * Note: This call has network activity and so, any calls made must be from
	 * a background thread
	 * 
	 * @param courseid
	 *            Moodle courseid of the course
	 * @return syncStatus
	 * 
	 * @author Praveen Kumar Pendyala (praveen@praveenkumar.co.in)
	 */
	public Boolean syncCourseContents(int courseid) {

		// Get the course from database for all future use
		List<MoodleCourse> dbCourses = MoodleCourse.find(MoodleCourse.class,
				"siteid = ? and courseid = ?", String.valueOf(siteid), String.valueOf(courseid));
		if (dbCourses == null || dbCourses.isEmpty()) {
			error = "Course not found in database!";
			return false;
		}
		course = dbCourses.get(0);

		MoodleRestCourseContent mrcc = new MoodleRestCourseContent(mUrl, token);
		ArrayList<MoodleSection> mSections = mrcc.getCourseContent(String.valueOf(courseid));

		/** Error checking **/
		if (mSections == null) {
			error = "Network issue!";
			return false;
		}

		// Some network or encoding issue.
		if (mSections.isEmpty()) {
			error = "No data received! Permissions issue?";
			return false;
		}

		// Add relational fields to all sections and update
		MoodleSection section = new MoodleSection();
		List<MoodleSection> dbSections;
		for (int i = 0; i < mSections.size(); i++) {
			section = mSections.get(i);
			section.setSiteid(siteid);
			section.setCourseid(courseid);
			section.setParentid(course.getId());

			// Update or save in database
			dbSections = MoodleSection.find(MoodleSection.class,
					"sectionid = ? and siteid = ?",
					String.valueOf(section.getSectionid()), String.valueOf(section.getSiteid()));
			if (!dbSections.isEmpty())
				section.setId(dbSections.get(0).getId()); // updates on save()
			section.save();

			// Now loop all modules in this section
			syncModules(section.getModules(), section.getId(),
					section.getSectionid());
		}

		return true;
	}

	/**
	 * 
	 * @param modules
	 *            ArrayList of modules to be synced
	 * @param sectiondbid
	 *            Database id of the section to which these modules belong
	 * @param sectionid
	 *            Moodle sectionid of the section to which these modules belong
	 * 
	 * @author Praveen Kumar Pendyala (praveen@praveenkumar.co.in)
	 */
	private void syncModules(ArrayList<MoodleModule> modules, Long sectiondbid,
			int sectionid) {

		// No modules in section
		if (modules == null)
			return;

		// Add relational fields to all modules and update
		MoodleModule module = new MoodleModule();
		List<MoodleModule> dbModules;
		for (int i = 0; i < modules.size(); i++) {
			module = modules.get(i);
			module.setSiteid(siteid);
			module.setCourseid(course.getCourseid());
			module.setParentid(sectiondbid);
			module.setSectionid(sectionid);

			// Update or save in database
			/*
			 * -TODO- Should more conditions be added?
			 */
			dbModules = MoodleModule.find(MoodleModule.class,
					"moduleid = ? and siteid = ?", String.valueOf(module.getModuleid()),
					String.valueOf(module.getSiteid()));
			if (!dbModules.isEmpty())
				module.setId(dbModules.get(0).getId()); // updates on save()
			// set notifications if enabled
			else if (notification) {
				new MDroidNotification(siteid,
						MDroidNotification.TYPE_COURSE_CONTENT,
						"New contents in " + course.getShortname(),
						module.getName() + " added to " + course.getFullname(),
						1, course.getCourseid()).save();
				notificationcount++;
			}
			module.save();

			// Now loop all Module contents in this module
			syncModuleContents(module.getContents(), module.getId(),
					module.getModuleid(), sectionid);
		}

	}

	/**
	 * 
	 * @param modulecontents
	 *            ArrayList of modulecontent to be synced
	 * @param moduledbid
	 *            Database id of the module to which these contents belong
	 * @param moduleidid
	 *            Moodle moduleid of the module to which these contents belong
	 * @param sectionid
	 *            Moodle sectionid of the section to which these modules belong
	 * 
	 * @author Praveen Kumar Pendyala (praveen@praveenkumar.co.in)
	 */
	private void syncModuleContents(ArrayList<MoodleModuleContent> contents,
			Long moduledbid, int moduleid, int sectionid) {

		// No modules in section
		if (contents == null)
			return;

		// Add relational fields to all modules and update
		MoodleModuleContent content = new MoodleModuleContent();
		List<MoodleModuleContent> dbContents;
		for (int i = 0; i < contents.size(); i++) {
			content = contents.get(i);
			content.setSiteid(siteid);
			content.setCourseid(course.getCourseid());
			content.setParentid(moduledbid);
			content.setSectionid(sectionid);
			content.setModuleid(moduleid);

			// Update or save in database
			dbContents = MoodleModuleContent.find(MoodleModuleContent.class,
					"parentid = ? and siteid = ?", String.valueOf(content.getParentid()),
					String.valueOf(content.getSiteid()));
			if (!dbContents.isEmpty())
				content.setId(dbContents.get(0).getId()); // updates on save()
			content.save();
		}

	}

	/**
	 * Get a list of all sections is a Course. <br/>
	 * Note: Depending on the contents of a course, this could take some time as
	 * it runs many sql queries. It is recommended that this method is called
	 * from a background thread
	 * 
	 * @param courseid
	 *            Moodle courseid of the course
	 * @return List of sections
	 * 
	 * @author Praveen Kumar Pendyala (praveen@praveenkumar.co.in)
	 */
	public ArrayList<MoodleSection> getCourseContents(int courseid) {
		List<MoodleSection> sections = MoodleSection.find(MoodleSection.class,
				"courseid = ? and siteid = ?", String.valueOf(courseid), String.valueOf(siteid));

		// Add modules to sections
		List<MoodleModule> dbModules;
		List<MoodleModuleContent> dbContents;
		for (int i = 0; i < sections.size(); i++) {
			dbModules = MoodleModule.find(MoodleModule.class, "parentid = ?",
					String.valueOf(sections.get(i).getId()));

			// Set module contents to modules
			for (int j = 0; j < dbModules.size(); j++) {
				dbContents = MoodleModuleContent.find(
						MoodleModuleContent.class, "parentid = ?", String.valueOf(dbModules
								.get(j).getId()));
				dbModules.get(j).setContents(dbContents);
			}

			sections.get(i).setModules(dbModules);
		}

		return new ArrayList<>(sections);
	}
}