R/jobs.R

In skranz/courser: Manage Course Activities like slides, clicker, RTutor Problemsets or Peer-Quizzes

examples.find.courser.jobs = function() {
  restore.point.options(display.restore.point=TRUE)
  course.dir = "D:/libraries/courser/courses/vwl"
  setwd(course.dir)

  jo = cojo_init(course.dir=course.dir) %>%
    cojo_find()

  jo = jo %>%
    cojo_perform()

  jo = jo%>%
    cojo_send_emails()

  jo$em.li
  cat(jo$email.txt)

  jobs = find.courser.jobs(course.dir)
  perform.courser.jobs(jobs, course.dir=course.dir)


}

# load and store data about jobs
cojo_init = function(jo=NULL,course.dir=jo$course.dir, db = get.studentdb(course.dir)) {
  restore.point("cojo_init")


  schema.file = system.file("schema/studentdb.yaml", package="courser")
  schemas = load.and.init.schemas(schema.file)

  #li = parse.hashdot.yaml(txt)
  em.cr.li = compile.courser.email.templates(course.dir=course.dir)

  settings = course.settings(course.dir)

  students = dbGet(db,"students", schemas=schemas)

  students$url.clicker = paste0(settings$base_url,":",settings$clicker$port,"/clicker?key=", students$token)

  students$url.coursepage = paste0(settings$base_url,":",settings$coursepage$port,"/coursepage?key=", students$token)



  pq.dir = file.path(course.dir,"course","peerquiz")
  has.pq = dir.exists(pq.dir)
  if (has.pq) {
    set.pq.opts(init.pq.opts(pq.dir=pq.dir))
  }

  jo = list(
    course.dir = course.dir,
    settings = settings,
    db = db,
    schemas=schemas,
    students = students,
    send.email = rep(FALSE, NROW(students)),
    em.li = list(),
    em.cr.li = em.cr.li,
    time = Sys.time(),
    has.pq = has.pq,
    pq.dir = pq.dir
  )
  jo$course.title = first.non.null(jo$settings$course.title,basename(course.dir))

  email.enclos = as.environment(list(
    num.stud = NROW(students),
    num.clicker = 0,
    course.title = jo$course.title
  ))
  parent.env(email.enclos) = parent.frame()
  jo$email.enclos = email.enclos

  jo
}

# search for automatic jobs like updating the highscore
# and sending emails
cojo_find = function(jo,...) {
  restore.point("cojo_find")
  course.dir = jo$course.dir
  jo$jobs = NULL
  jo %>%
    cojo_find_clicker() %>%
    cojo_find_peerquiz()
}

# search for automatic jobs like updating the highscore
# and sending emails
cojo_find_clicker = function(jo) {
  restore.point("cojo_find_clicker")
  course.dir = jo$course.dir
  jobs = jo$jobs

  # check if there was run new clicker task tag
  # since the highscore was last send
  last.task.file = file.path(course.dir,"course","clicker","LAST_TASK.txt")

  has.task = file.exists(last.task.file)
  if (has.task) {
    last.email.file = file.path(course.dir,"course","clicker","LAST_EMAIL.txt")
    if (!file.exists(last.email.file)) {
      jo$last.email.clicker.session.num = 0
      jobs = c(jobs,"hs_clicker")

    } else {
      task.time = file.mtime(last.task.file)
      email.time = file.mtime(last.email.file)
      if ((task.time > email.time)) {
        jo$last.email.clicker.session.num = as.integer(readLines(last.email.file))
        jobs = c(jobs,"hs_clicker")
      }
    }
  }
  jo$jobs = jobs
  jo
}


# search for automatic jobs like updating the highscore
# and sending emails
cojo_find_peerquiz = function(jo, tt=NULL) {
  restore.point("cojo_find_peerquiz")

  if (isTRUE(jo$has.pq)) {
    jo$jobs = c(jo$jobs, "peerquiz")
  }

  jo
}





cojo_perform = function(jo, jobs=jo$jobs) {
  restore.point("cojo_perform")
  jo$jobs = jobs
  if ("hs_clicker" %in% jobs) {
    jo = cojo_perform_clicker(jo)
  }
  if ("peerquiz" %in% jobs) {
    jo = cojo_perform_peerquiz(jo)
  }
  jo = cojo.make.full.emails(jo)
  jo
}

cojo_perform_clicker = function(jo) {
  restore.point("cojo_perform_clicker")
  course.dir = jo$course.dir;

  hs = compute.course.clicker.highscore(course.dir=course.dir, students=jo$students)

  if (is.null(hs)) return(jo)

  jo$email.enclos$num.clicker = length(unique(hs$userid))


  # specify sessions that will be included in the emails
  session.nums = unique(hs$session.num)
  session.nums = session.nums[session.nums > jo$last.email.clicker.session.num]
  # create email content for each clicker sessions
  for (session.num in sort(session.nums)) {
    jo = cojo.clicker.highscore.email(jo,hs,session.num)
  }

  jo$hs_clicker = hs
  jo
}


cojo_perform_peerquiz = function(jo, tt=NULL) {
  restore.point("cojo_perform_peerquiz")
  if (is.null(tt))
    tt = pq.load.time.table(pq.dir=jo$pq.dir, convert.date.times = TRUE)

  pqs = get.pq.states(tt=tt)

  last.email.file = file.path(course.dir,"course","peerquiz","LAST_EMAIL.json")
  cdf = filter(pqs, active)
  if (file.exists(last.email.file)) {
    old.sdf = read_json(last.email.file,TRUE)
    colnames(old.sdf)[2] = "prev.state"
    cdf = left_join(cdf, old.sdf, by="id")
    cdf$prev.state[is.na(cdf$prev.state)] = ""
  } else {
    cdf$prev.state = ""
  }

  # add jobs depending on new state in cdf
  # Add to email if we have a new state
  for (row in which(cdf$state != cdf$prev.state)) {
    pqs = cdf[row,]
    jo = cojo.peerquiz.email(jo=jo,pqs = pqs)
  }


  sdf = select(cdf, id, state)
  # save new states
  write_json(sdf,last.email.file)

  jo
}

cojo.peerquiz.email = function(jo, id=pqs$id, state=pqs$state,pqs, pq=load.or.compile.pq(id=id, pq.dir=jo$pq.dir)) {
  restore.point("cojo.peerquiz.email")

  env = jo$email.enclos
  env$pq.title = str.trim(pq$title)
  env$start_write = pqs$start_write
  env$start_guess = pqs$start_guess
  env$end_guess = pqs$end_guess

  str = rep("", NROW(jo$students))
  if (state == "write") {
    str = render.vectorized.compiled.rmd(jo$em.cr.li$peerquiz_write,df = jo$students,enclos = env)
  } else if (state=="guess") {
    str = render.vectorized.compiled.rmd(jo$em.cr.li$peerquiz_guess,df = jo$students,enclos = env)
  } else if (state == "closed") {
    rows = jo$students$emailRanking
    #if (sum(rows)>0) {
    #  str[rows] = render.vectorized.compiled.rmd(jo$em.cr.li$quiz_ranking, df[rows,],enclos = jo$email.enclos)
    #}

  }


  jo$em.li[[paste0("peerquiz_", id)]] = str
  jo$send.email = jo$send.email | nchar(str)>0
  jo
}


cojo.clicker.highscore.email = function(jo, hs, session.num) {
  restore.point("cojo.clicker.highscore.email")

  # create df to evaluate
  hs=hs[hs$session.num == session.num,]
  hs$userid = tolower(hs$userid)
  df = left_join(jo$students, hs,by="userid")
  #df$course.title = jo$course.title
  #df$num.stud = NROW(jo$students)

  str = rep("", NROW(jo$students))

  # select students who participated
  # at least once at the quiz
  # and who have set option to send
  # email ranking
  rows = jo$students$emailRanking & !is.na(df$cum.points)
  if (sum(rows)>0) {
    str[rows] = render.vectorized.compiled.rmd(jo$em.cr.li$quiz_ranking, df[rows,],enclos = jo$email.enclos)
  }

  jo$em.li[[paste0("quiz_ranking_", session.num)]] = str
  jo$send.email = jo$send.email | nchar(str)>0
  jo

}

cojo.make.full.emails = function(jo) {
  restore.point("cojo.make.full.emails")

  is.email = grepl("@", jo$students$email, fixed=TRUE)
  jo$send.email = jo$send.email & is.email

  rows = which(jo$send.email)
  n = length(rows)
  jo$email.txt = jo$email.title = header = footer = rep("", NROW(jo$students))
  if (n==0) return(jo)

  df = jo$students[rows,]

  jo$email.subject[rows] = render.vectorized.compiled.rmd(jo$em.cr.li$subject, df,enclos = jo$email.enclos)

  header[rows] = render.vectorized.compiled.rmd(jo$em.cr.li$header, df,enclos = jo$email.enclos)
  footer[rows] = render.vectorized.compiled.rmd(jo$em.cr.li$footer, df,enclos = jo$email.enclos)

  str = do.call(paste0, c(list(header),jo$em.li,list(footer)))
  jo$email.txt = str

  #cat(str)
  jo
}


cojo_send_emails = function(jo) {
  restore.point("cojo_send_emails")
  rows = which(jo$send.email)

  from = jo$settings$email$from
  control = list(smtpServer = jo$settings$email$smtpServer)
  for (row in rows) {
    stud = as.list(jo$students[row,])
    if (!is.true(has.substr(stud$email,"@"))) {
      cat("\nskip email for ", stud$email, " since that is no valid email adress.")
      next
    }
    cat("\nSend email to ", stud$email, " with title ",jo$email.subject[row],"...")
    sendmailR::sendmail(from=from, to=stud$email, subject=jo$email.subject[row], msg = sep.lines(jo$email.txt[row]), control=control)
  }

  # Create a last.email.file to avoid double
  # sending of clicker.highscore
  last.email.file = file.path(jo$course.dir,"course","clicker","LAST_EMAIL.txt")
  writeLines("send", last.email.file)

  jo
}


compile.courser.email.templates = function(file = file.path(course.dir, "course","settings","emails.Rmd"), course.dir=NULL) {
  restore.point("compile.courser.email.templates")
  txt = readUtf8(file,sep.lines = FALSE)
  #cr = compile.rmd(text=txt,fragment.only = TRUE,out.type = "md")

  li = parse.hashdot.yaml(txt)
  cr.li = lapply(li, function(txt) {
    compile.rmd(text = txt,fragment.only = TRUE,out.type = "md")
  })
  cr.li
}