/// <summary>
/// Gives the given OSBLE user access to the annotate document identified by the
/// supplied docCode and docString.
/// </summary>
/// <param name="osbleUser"></param>
/// <param name="docCode"></param>
/// <param name="docDate"></param>
/// <returns></returns>
public AnnotateResult GiveAccessToDocument(UserProfile osbleUser, string docCode, string docDate)
{
AnnotateResult result = new AnnotateResult();
result.Result = ResultCode.ERROR;
string webResult = "";
long epoch = (int)(DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0)).TotalSeconds;
WebClient client = new WebClient();
//give user access to the new document
string apiKey = GenerateAnnotateKey("authorizeReader.php", osbleUser.UserName, epoch);
//TODO: this was changed when helplab.org went down.
//string authorizeString = "http://helplab.org/annotate/php/authorizeReader.php?" +
string authorizeString = AnnotateURL + "/annotate/php/authorizeReader.php?" +
"api-user={0}" + //Annotate admin user name (see web config)
"&api-requesttime={1}" + //UNIX timestamp
"&api-annotateuser={2}" + //the current user (reviewer)
"&api-auth={3}" + //Annotate admin auth key
"&d={4}" + //document upload date
"&c={5}"; //document code
authorizeString = string.Format(authorizeString,
ApiUser,
epoch,
osbleUser.UserName,
apiKey,
docDate,
docCode
);
try
{
webResult = client.DownloadString(authorizeString);
//WriteLog("GiveAccessToDocument: " + webResult);
result.RawMessage = webResult;
}
catch (Exception)
{
throw;
}
if (webResult.Substring(0, 2) == "OK")
{
result.Result = ResultCode.OK;
}
return(result);
}
/// <summary>
/// Sets the anonymity settings for the given document.
/// </summary>
/// <param name="user"></param>
/// <param name="docCode"></param>
/// <param name="docDate"></param>
/// <param name="isAnonymous"></param>
/// <param name="anonName"></param>
/// <returns></returns>
public AnnotateResult SetDocumentAnonymity(UserProfile user, string docCode, string docDate, CriticalReviewSettings settings, string anonName = "anonymous")
{
AnnotateResult result = new AnnotateResult();
result.Result = ResultCode.ERROR;
WebClient client = new WebClient();
string webResult = "";
long epoch = (int)(DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0)).TotalSeconds;
//apiAddUserMapping.php does not exist! it appears to be a custom file...
//TODO: re-create...
string apiKey = GenerateAnnotateKey("apiAddUserMapping.php", user.UserName, epoch);
Dictionary <string, string> mapping = new Dictionary <string, string>();
mapping["other"] = "anonymous";
mapping[user.UserName] = anonName;
string jsonMapping = (new JavaScriptSerializer()).Serialize(mapping);
int enable = 1;
if (settings.AnonymizeComments == false)
{
enable = 0;
}
//TODO: this was changed when helplab went down.
//string anonString = "http://helplab.org/annotate/php/apiAddUserMapping.php?" +
string anonString = AnnotateURL + "/annotate/php/apiAddUserMapping.php?" +
"api-user={0}" + //Annotate admin user name (see web config)
"&api-auth={1}" + //Annotate admin auth key
"&api-requesttime={2}" + //UNIX timestamp
"&api-annotateuser={3}" + //current user (not used?)
"&date={4}" + //date for document
"&code={5}" + //code for document
"&mapping={6}" + //anonymous mapping
"&enable={7}"; //enable or disable mapping
//"&rm={8}"; //add or remove mapping
anonString = string.Format(anonString,
ApiUser,
apiKey,
epoch,
user.UserName,
docDate,
docCode,
jsonMapping,
enable
//""
);
try
{
webResult = client.DownloadString(anonString);
//WriteLog("SetDocumentAnnonymity: " + webResult);
result.RawMessage = webResult;
}
catch (Exception)
{
throw;
}
if (webResult.Substring(0, 2) == "OK")
{
result.Result = ResultCode.OK;
}
return(result);
}
public AnnotateResult ToggleCommentVisibility(int criticalReviewAssignmentID, int authorTeamID, bool makeVisible)
{
AnnotateResult result = new AnnotateResult();
Assignment criticalReview;
result.Result = ResultCode.ERROR;
string webResult = "";
long epoch = (int)(DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0)).TotalSeconds;
string apiKey = GenerateAnnotateKey("listNotes.php", ApiUser, epoch);
WebClient client = new WebClient();
using (OSBLEContext db = new OSBLEContext())
{
criticalReview = db.Assignments.Find(criticalReviewAssignmentID);
//step 1: find all people reviewing the document
var query = (from rt in db.ReviewTeams
.Include("CourseUser")
.Include("CourseUser.UserProfile")
where rt.AssignmentID == criticalReviewAssignmentID &&
rt.AuthorTeamID == authorTeamID
select rt.ReviewingTeam)
.SelectMany(t => t.TeamMembers)
.Distinct();
List <TeamMember> reviewers = query.ToList();
//step 2: get all comments for each reviewer on the team
AnnotateResult documentResult = UploadDocument((int)criticalReview.PrecededingAssignmentID, authorTeamID);
//TODO: the following line was replaced when helplab went down. change again when needed.
//string rawNoteUrl = "http://helplab.org/annotate/php/listNotes.php?" +
string rawNoteUrl = AnnotateURL + "/annotate/php/listNotes.php?" +
"api-user={0}" + //Annotate admin user name (see web config)
"&api-requesttime={1}" + //UNIX timestamp
"&api-annotateuser={2}" + //the current user (reviewer)
"&api-auth={3}" + //Annotate admin auth key
"&d={4}" + //document date
"&c={5}"; //document code
string noteUrl = "";
foreach (TeamMember reviewer in reviewers)
{
//always refresh our epoch and api key
epoch = (int)(DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0)).TotalSeconds;
apiKey = GenerateAnnotateKey("listNotes.php", reviewer.CourseUser.UserProfile.UserName, epoch);
noteUrl = string.Format(rawNoteUrl,
ApiUser,
epoch,
reviewer.CourseUser.UserProfile.UserName,
apiKey,
documentResult.DocumentDate,
documentResult.DocumentCode
);
try
{
webResult = client.DownloadString(noteUrl);
dynamic jsonResult = Json.Decode(webResult);
}
catch (Exception)
{
throw;
}
}
}
return(result);
}
/// <summary>
/// Creates an account for the specified OSBLE user. If the user already exists
/// on the annotate server, nothing will happen. Any new user is created as an
/// "annotating" user, which means that they can annotate a document, but cannot
/// upload documents of thier own.
/// </summary>
/// <param name="osbleUser"></param>
/// <returns></returns>
public AnnotateResult CreateAccount(UserProfile osbleUser)
{
AnnotateResult result = new AnnotateResult();
string webResult = "";
long epoch = (int)(DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0)).TotalSeconds;
WebClient client = new WebClient();
//create annotate account for user
string apiKey = GenerateAnnotateKey("createAccount.php", osbleUser.UserName, epoch);
//TODO: this was changed when helplab.org went down.
//string createString = "http://helplab.org/annotate/php/createAccount.php?" +
string createString = AnnotateURL + "/annotate/php/createAccount.php?" +
"api-user={0}" + //Annotate admin user name (see web config)
"&api-requesttime={1}" + //UNIX timestamp
"&api-annotateuser={2}" + //the current user (reviewer)
"&api-auth={3}" + //Annotate admin auth key
"&licensed=0 " +
"&firstname={4}" + //User's first name
"&lastname={5}"; //User's last name
createString = string.Format(createString,
ApiUser,
epoch,
osbleUser.UserName,
apiKey,
osbleUser.FirstName,
osbleUser.LastName
);
webResult = client.DownloadString(createString);
//WriteLog("CreateAccount1: " + webResult);
//downgrade user to unlicensed if not OSBLE admin
if (osbleUser.IsAdmin == false)
{
apiKey = GenerateAnnotateKey("updateAccount.php", osbleUser.UserName, epoch);
//TODO: this was changed when helplab.org went down.
//string updateString = "http://helplab.org/annotate/php/updateAccount.php?" +
string updateString = AnnotateURL + "/annotate/php/updateAccount.php?" +
"api-user={0}" + //Annotate admin user name (see web config)
"&api-requesttime={1}" + //UNIX timestamp
"&api-annotateuser={2}" + //the current user (reviewer)
"&api-auth={3}" + //Annotate admin auth key
"&licensed=0 ";
updateString = string.Format(updateString,
ApiUser,
epoch,
osbleUser.UserName,
apiKey
);
try
{
webResult = client.DownloadString(updateString);
//WriteLog("CreateAccount2: " + webResult);
result.RawMessage = webResult;
}
catch (Exception)
{
throw;
}
}
result.RawMessage = webResult;
if (webResult.Substring(0, 2) == "OK")
{
result.Result = ResultCode.OK;
}
else
{
result.Result = ResultCode.ERROR;
}
return(result);
}
/// <summary>
/// Sends a document that resides on OSBLE to the Annotate server.
/// If the document already exists on annotate's servers, this function will not resubmit
/// unless forceUpload is set to TRUE.
/// </summary>
/// <param name="assignmentID">The assignment that the document belongs to</param>
/// <param name="authorTeamID">The document's author</param>
/// <param name="forceUpload">If set to TRUE, will force a document upload to annotate's servers</param>
/// <returns></returns>
public AnnotateResult UploadDocument(int assignmentID, int authorTeamID, bool forceUpload = false)
{
bool needsUpload = true;
AnnotateResult result = new AnnotateResult();
result.Result = ResultCode.ERROR;
//By default, we only upload documents to annotate if they haven't been uploaded
//already. This can be overridden by setting forceUpload = true.
if (forceUpload == false)
{
//check for existing document
using (OSBLEContext db = new OSBLEContext())
{
string docString = GetAnnotateDocumentName(assignmentID, authorTeamID);
AnnotateDocumentReference code = (from c in db.AnnotateDocumentReferences
where c.OsbleDocumentCode.CompareTo(docString) == 0
select c
).FirstOrDefault();
if (code == null)
{
needsUpload = true;
}
else
{
needsUpload = false;
result.Result = ResultCode.OK;
result.DocumentDate = code.AnnotateDocumentDate;
result.DocumentCode = code.AnnotateDocumentCode;
}
}
}
if (needsUpload)
{
long epoch = (int)(DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0)).TotalSeconds;
WebClient client = new WebClient();
string sendResult = "";
//Submit document to annotate
#if DEBUG
//string documentUrl = "http://osble.org/content/icershort.pdf";
string documentUrl = "https://plus.osble.org/FileHandler/GetAnnotateDocument?assignmentID={0}&authorTeamID={1}&apiKey={2}";
documentUrl = string.Format(documentUrl, assignmentID, authorTeamID, ApiKey);
#else
string documentUrl = "https://plus.osble.org/FileHandler/GetAnnotateDocument?assignmentID={0}&authorTeamID={1}&apiKey={2}";
documentUrl = string.Format(documentUrl, assignmentID, authorTeamID, ApiKey);
#endif
string apiKey = GenerateAnnotateKey("uploadDocument.php", ApiUser, epoch);
//TODO: this was changed when helplab.org went down.
//string uploadString = "http://helplab.org/annotate/php/uploadDocument.php?" +
string uploadString = AnnotateURL + "/annotate/php/uploadDocument.php?" +
"api-user={0}" + //Annotate admin user name (see web config)
"&api-requesttime={1}" + //UNIX timestamp
"&api-annotateuser={2}" + //the current user (reviewer)
"&api-auth={3}" + //Annotate admin auth key
"&url={4}"; //URL of the document to upload
uploadString = string.Format(uploadString,
ApiUser,
epoch,
ApiUser,
apiKey,
HttpUtility.UrlEncode(documentUrl)
);
try
{
sendResult = client.DownloadString(uploadString);
//WriteLog("UploadDocument: " + sendResult);
}
catch (Exception ex)
{
result.RawMessage = ex.Message;
result.Result = ResultCode.ERROR;
return(result);
}
string documentCode = "";
string documentDate = "";
result.RawMessage = sendResult;
if (sendResult.Substring(0, 2) == "OK")
{
result.Result = ResultCode.OK;
string[] pieces = sendResult.Split(' ');
documentDate = pieces[1];
documentCode = pieces[2];
result.DocumentCode = documentCode;
result.DocumentDate = documentDate;
//add DB entry into OSBLE so that we know something's been sent
using (OSBLEContext db = new OSBLEContext())
{
string docString = GetAnnotateDocumentName(assignmentID, authorTeamID);
AnnotateDocumentReference code = (from c in db.AnnotateDocumentReferences
where c.OsbleDocumentCode.CompareTo(docString) == 0
select c
).FirstOrDefault();
if (code == null)
{
code = new AnnotateDocumentReference();
db.AnnotateDocumentReferences.Add(code);
}
else
{
db.Entry(code).State = EntityState.Modified;
}
code.AnnotateDocumentCode = result.DocumentCode;
code.AnnotateDocumentDate = result.DocumentDate;
code.OsbleDocumentCode = docString;
db.SaveChanges();
}
}
}
return(result);
}
