static const char BYDAY[] = "BYDAY";
static const char DAILY[] = "DAILY";
-
-/**
- * Parses periodStr and populate struct IotvtICalPeriod_t
- *
- * @param periodStr string to be parsed.
- * @param period IotvtICalPeriod_t struct to be populated.
- *
- * @return IOTVTICAL_INVALID_PARAMETER -- if parameter are invalid
- * IOTVTICAL_INVALID_PERIOD -- if period string has invalid format
- * IOTVTICAL_INVALID_SUCCESS -- if no error while parsing
- */
IotvtICalResult_t ParsePeriod(const char *periodStr, IotvtICalPeriod_t *period)
{
- if((NULL == periodStr) || (NULL == period))
+ if ((NULL == periodStr) || (NULL == period))
{
return IOTVTICAL_INVALID_PARAMETER;
}
//startDateTime and endDateTime must be same form
//Eg: periodStr = "20150629T153050/20150630T203055"
// periodStr = "20150629/20150630"
- if(NULL == (endDTPos = strchr(periodStr, '/')))
+ if (NULL == (endDTPos = strchr(periodStr, '/')))
{
return IOTVTICAL_INVALID_PERIOD;
}
endDTLen = strlen(endDTPos);
//Checking if both startDateTime and endDateTime are of same form
- if(startDTLen == endDTLen)
+ if (startDTLen == endDTLen)
{
- if(8 == startDTLen) //YYYYmmdd
+ if (8 == startDTLen) //YYYYmmdd
{
fmt = dFormat;
}
- else if(15 == startDTLen) //YYYYmmddTHHMMSS
+ else if (15 == startDTLen) //YYYYmmddTHHMMSS
{
fmt = dtFormat;
}
}
//Checking if startDateTime has right format
- if(NULL != strptime(periodStr, fmt, &period->startDateTime))
+ if (NULL != strptime(periodStr, fmt, &period->startDateTime))
{
//Checking if endDateTime has right format
- if(NULL != strptime(endDTPos, fmt, &period->endDateTime))
+ if (NULL != strptime(endDTPos, fmt, &period->endDateTime))
{
//Checking if endDateTime is after startDateTime
- if(difftime(mktime(&period->endDateTime),
- mktime(&period->startDateTime)) > 0)
+ if ((period->startDateTime.tm_year > period->endDateTime.tm_year)
+ || ((period->startDateTime.tm_year == period->endDateTime.tm_year)
+ && (period->startDateTime.tm_mon > period->endDateTime.tm_mon))
+ || ((period->startDateTime.tm_year == period->endDateTime.tm_year)
+ && (period->startDateTime.tm_mon == period->endDateTime.tm_mon)
+ && (period->startDateTime.tm_mday > period->endDateTime.tm_mday))
+ || (( fmt == dtFormat) && (period->startDateTime.tm_year == period->endDateTime.tm_year)
+ && (period->startDateTime.tm_mon == period->endDateTime.tm_mon)
+ && (period->startDateTime.tm_mday == period->endDateTime.tm_mday)
+ && (period->startDateTime.tm_hour > period->endDateTime.tm_hour))
+ || (( fmt == dtFormat) && (period->startDateTime.tm_year == period->endDateTime.tm_year)
+ && (period->startDateTime.tm_mon == period->endDateTime.tm_mon)
+ && (period->startDateTime.tm_mday == period->endDateTime.tm_mday)
+ && (period->startDateTime.tm_hour == period->endDateTime.tm_hour)
+ && (period->startDateTime.tm_min > period->endDateTime.tm_min))
+ || (( fmt == dtFormat) && (period->startDateTime.tm_year == period->endDateTime.tm_year)
+ && (period->startDateTime.tm_mon == period->endDateTime.tm_mon)
+ && (period->startDateTime.tm_mday == period->endDateTime.tm_mday)
+ && (period->startDateTime.tm_hour == period->endDateTime.tm_hour)
+ && (period->startDateTime.tm_min == period->endDateTime.tm_min)
+ && (period->startDateTime.tm_sec > period->endDateTime.tm_sec)))
+ {
+ return IOTVTICAL_INVALID_PERIOD;
+ }
+ else
{
- //mktime increases value of tm_hour by 1 if tm_isdst is set.
- //The tm_hour value in period's startDateTime and endDatetime
- //should remain same irrespective of daylight saving time.
- if(period->startDateTime.tm_isdst)
- {
- period->startDateTime.tm_hour =
- (period->startDateTime.tm_hour + TOTAL_HOURS - TM_DST_OFFSET) % TOTAL_HOURS;
- }
- if(period->endDateTime.tm_isdst)
- {
- period->endDateTime.tm_hour =
- (period->endDateTime.tm_hour + TOTAL_HOURS - TM_DST_OFFSET) % TOTAL_HOURS;
- }
return IOTVTICAL_SUCCESS;
}
}
return IOTVTICAL_INVALID_PERIOD;
}
-
/**
- * Parses untilRule and populate "until" field of struct IotvtICalRecur_t
+ * Parses untilRule and populate "until" field of struct IotvtICalRecur_t.
*
- * @param untilRule string to be parsed.
- * @param recur IotvtICalRecur_t struct to be populated.
+ * @param untilRule is a string to be parsed.
+ * @param recur is the reference to the @ref IotvtICalRecur_t to be populated.
*
- * @return IOTVTICAL_ERRRO -- if untilRule has invalid format
- * IOTVTICAL_INVALID_SUCCESS -- if no error while parsing
+ * @return ::IOTVTICAL_SUCCESS is succesful, else in case of error
+ * ::IOTVTICAL_ERROR, if untilRule has invalid format or ::IOTVTICAL_INVALID_SUCCESS,
+ * if no error while parsing.
*/
static IotvtICalResult_t ParseDate(char *untilRule, IotvtICalRecur_t *recur)
{
char *date = strchr(untilRule, '=');
- if(NULL == date)
+ if (NULL == date)
{
return IOTVTICAL_ERROR;
}
date += 1;
- if(strlen(date) == 8) //YYYYmmdd
+ if (strlen(date) == 8) //YYYYmmdd
{
- if(NULL != strptime(date, dFormat, &recur->until))
+ if (NULL != strptime(date, dFormat, &recur->until))
{
return IOTVTICAL_SUCCESS;
}
return IOTVTICAL_ERROR;
}
-
/**
- * Parses bydayRule and populate "byDay" field of struct IotvtICalRecur_t
+ * Parses bydayRule and populate "byDay" field of struct @ref IotvtICalRecur_t.
*
- * @param bydayRule string to be parsed.
- * @param recur IotvtICalRecur_t struct to be populated.
+ * @param bydayRule is a string to be parsed.
+ * @param recur is a reference to @ref IotvtICalRecur_t struct to be populated.
*
- * @return IOTVTICAL_ERRRO -- if bydayRule has empty weekday list or invalid weekdays
- * IOTVTICAL_INVALID_SUCCESS -- if no error while parsing
+ * @return ::IOTVTICAL_SUCCESS is succesful, else in case of error ::IOTVTICAL_ERROR,
+ * if bydayRule has empty weekday list or invalid weekdays.
*/
static IotvtICalResult_t ParseByday(char *bydayRule, IotvtICalRecur_t *recur)
{
- if(strstr(bydayRule, "SU"))
+ if (strstr(bydayRule, "SU"))
{
recur->byDay = recur->byDay | SUNDAY;
}
- if(strstr(bydayRule, "MO"))
+ if (strstr(bydayRule, "MO"))
{
recur->byDay = recur->byDay | MONDAY;
}
- if(strstr(bydayRule, "TU"))
+ if (strstr(bydayRule, "TU"))
{
recur->byDay = recur->byDay | TUESDAY;
}
- if(strstr(bydayRule, "WE"))
+ if (strstr(bydayRule, "WE"))
{
recur->byDay = recur->byDay | WEDNESDAY;
}
- if(strstr(bydayRule, "TH"))
+ if (strstr(bydayRule, "TH"))
{
recur->byDay = recur->byDay | THURSDAY;
}
- if(strstr(bydayRule, "FR"))
+ if (strstr(bydayRule, "FR"))
{
recur->byDay = recur->byDay | FRIDAY;
}
- if(strstr(bydayRule, "SA"))
+ if (strstr(bydayRule, "SA"))
{
recur->byDay = recur->byDay | SATURDAY;
}
//Checking if byDay list is empty or has inValid weekdays
- if(recur->byDay == NO_WEEKDAY)
+ if (recur->byDay == NO_WEEKDAY)
{
return IOTVTICAL_ERROR;
}
return IOTVTICAL_SUCCESS;
}
-
-/**
- * Parses recurStr and populate struct IotvtICalRecur_t
- *
- * @param recurStr string to be parsed.
- * @param recur IotvtICalPeriod_t struct to be populated.
- *
- * @return IOTVTICAL_INVALID_PARAMETER -- if parameter are invalid
- * IOTVTICAL_INVALID_PERIOD -- if period string has invalid format
- * IOTVTICAL_INVALID_RRULE -- if rrule string has invalid format
- */
IotvtICalResult_t ParseRecur(const char *recurStr, IotvtICalRecur_t *recur)
{
-
- if((NULL == recurStr) || (NULL == recur))
+ if ((NULL == recurStr) || (NULL == recur))
{
return IOTVTICAL_INVALID_PARAMETER;
}
startPos = recurStr;
//Iterates though recurrence rule
//Eg, RRULE: FREQ=DAILY; UNTIL=20150703; BYDAY=MO, WE, FR
- while('\0' != startPos)
+ while ('\0' != startPos)
{
endPos = strchr(startPos, ';');
- if(endPos)
+ if (endPos)
{
endPos += 1;
}
OICStrcpy(buf, (endPos - startPos), startPos);
- if(NULL != strstr(buf, FREQ))
+ if (NULL != strstr(buf, FREQ))
{
- if(NULL != strstr(buf, DAILY))
+ if (NULL != strstr(buf, DAILY))
{
recur->freq = FREQ_DAILY;
freqFlag = 1;
return IOTVTICAL_INVALID_RRULE;
}
}
- else if(NULL != strstr(buf, UNTIL))
+ else if (NULL != strstr(buf, UNTIL))
{
- if(IOTVTICAL_SUCCESS != ParseDate(buf, recur))
+ if (IOTVTICAL_SUCCESS != ParseDate(buf, recur))
{
return IOTVTICAL_INVALID_RRULE;
}
}
- else if(NULL != strstr(buf, BYDAY))
+ else if (NULL != strstr(buf, BYDAY))
{
- if(IOTVTICAL_SUCCESS != ParseByday(buf, recur))
+ if (IOTVTICAL_SUCCESS != ParseByday(buf, recur))
{
return IOTVTICAL_INVALID_RRULE;
};
startPos = endPos;
}
- if(1 != freqFlag)
+ if (1 != freqFlag)
{
return IOTVTICAL_INVALID_RRULE;
}
int days;
int leapDays=0;
- if(date2->tm_year > date1->tm_year)
+ if (date2->tm_year > date1->tm_year)
{
- for(int y = date1->tm_year; y < date2->tm_year; y++)
+ for (int y = date1->tm_year; y < date2->tm_year; y++)
{
y += TM_YEAR_OFFSET;
- if(y % 4 == 0 && (y % 100 != 0 || y % 400 == 0))
+ if (y % 4 == 0 && (y % 100 != 0 || y % 400 == 0))
{
leapDays += 1;
}
return days;
}
-
/**
* Computes number of seconds between two time.
*
(3600 * time1->tm_hour + 60 * time1->tm_min + time1->tm_sec);
}
-
/**
- * This API is used by policy engine to checks if the
- * request to access resource is within valid time.
+ * Validates if the @param currentTime is with in allowable period.
*
- * @param period string representing period.
- * @param recur string representing recurrence rule
+ * @param period allowable period.
+ * @param currentTime the time that need to be validated against allowable time.
*
- * @return IOTVTICAL_VALID_ACCESS -- if the request is within valid time period
- * IOTVTICAL_INVALID_ACCESS -- if the request is not within valid time period
- * IOTVTICAL_INVALID_PARAMETER -- if parameter are invalid
- * IOTVTICAL_INVALID_PERIOD -- if period string has invalid format
- * IOTVTICAL_INVALID_RRULE -- if rrule string has invalid format
+ * @return ::IOTVTICAL_VALID_ACCESS, if the request is within valid time period.
+ * ::IOTVTICAL_INVALID_ACCESS, if the request is not within valid time period.
+ * ::IOTVTICAL_INVALID_PARAMETER, if parameter are invalid.
*/
+static IotvtICalResult_t ValidatePeriod(IotvtICalPeriod_t *period, IotvtICalDateTime_t *currentTime)
+{
+ if (NULL == period || NULL == currentTime)
+ {
+ return IOTVTICAL_INVALID_PARAMETER;
+ }
+
+ bool validStartTime = true;
+ bool validEndTime = true;
+ bool validDay = false;
+ bool todayIsStartDay = (0 == DiffDays(&period->startDateTime, currentTime)) ? true : false;
+ bool todayIsEndDay = (0 == DiffDays(currentTime, &period->endDateTime)) ? true : false;
+
+ //If today is the start day of the allowable period then check
+ //currentTime > allowable period startTime
+ if (todayIsStartDay)
+ {
+ validStartTime = (0 <= DiffSecs(&period->startDateTime, currentTime)) ? true : false;
+ }
+
+ //If today is the end day of allowable period then check
+ //currentTime < allowable period endTime
+ if (todayIsEndDay)
+ {
+ validEndTime = (0 <= DiffSecs(currentTime, &period->endDateTime)) ? true :false;
+ }
-IotvtICalResult_t IsRequestWithinValidTime(char *periodStr, char *recurStr)
+ //Check if today is valid day between startDate and EndDate inclusive
+ if ((0 <= DiffDays(&period->startDateTime, currentTime)) &&
+ (0 <= DiffDays(currentTime, &period->endDateTime)))
+ {
+ validDay = true;
+ }
+
+ if (validDay && validStartTime && validEndTime)
+ {
+ return IOTVTICAL_VALID_ACCESS;
+ }
+ else
+ {
+ return IOTVTICAL_INVALID_ACCESS;
+ }
+}
+
+IotvtICalResult_t IsRequestWithinValidTime(const char *periodStr, const char *recurStr)
{
//NULL recur rule means no recurring patter exist.
//Period can't be null. Period is used with or without
//recur rule to compute allowable access time.
- if(NULL == periodStr)
+ if (NULL == periodStr)
{
return IOTVTICAL_INVALID_PARAMETER;
}
IotvtICalDateTime_t *currentTime = localtime(&rawTime);
ret = ParsePeriod(periodStr, &period);
- if(ret != IOTVTICAL_SUCCESS)
+ if (ret != IOTVTICAL_SUCCESS)
{
return ret;
}
- //If recur is NULL then the access time is between period's startDate and endDate
- if(NULL == recurStr)
+ //If recur is NULL then the access time is between period's startDateTime and endDateTime
+ if (NULL == recurStr)
{
- if((0 <= DiffDays(&period.startDateTime, currentTime)) &&
- (0 <= DiffDays(currentTime, &period.endDateTime)))
- {
- ret = IOTVTICAL_VALID_ACCESS;
- }
+ ret = ValidatePeriod(&period, currentTime);
}
//If recur is not NULL then the access time is between period's startTime and
//is computed from period's startDate and the last instance is computed from
//"UNTIL". If "UNTIL" is not specified then the recurrence goes for forever.
//Eg, RRULE: FREQ=DAILY; UNTIL=20150703; BYDAY=MO, WE, FR
- if(NULL != recurStr)
+ if (NULL != recurStr)
{
ret = ParseRecur(recurStr, &recur);
- if(ret != IOTVTICAL_SUCCESS)
+ if (ret != IOTVTICAL_SUCCESS)
{
return ret;
}
- if((0 <= DiffSecs(&period.startDateTime, currentTime))&&
+ if ((0 <= DiffSecs(&period.startDateTime, currentTime))&&
(0 <= DiffSecs(currentTime, &period.endDateTime)) &&
(0 <= DiffDays(&period.startDateTime, currentTime)))
{
ret = IOTVTICAL_VALID_ACCESS;
//"UNTIL" is an optional parameter of RRULE, checking if until present in recur
- if(0 != memcmp(&recur.until, &emptyDT, sizeof(IotvtICalDateTime_t)))
+ if (0 != memcmp(&recur.until, &emptyDT, sizeof(IotvtICalDateTime_t)))
{
if(0 > DiffDays(currentTime, &recur.until))
{
}
//"BYDAY" is an optional parameter of RRULE, checking if byday present in recur
- if(NO_WEEKDAY != recur.byDay)
+ if (NO_WEEKDAY != recur.byDay)
{
int isValidWD = (0x1 << currentTime->tm_wday) & recur.byDay; //Valid weekdays
- if(!isValidWD)
+ if (!isValidWD)
{
ret = IOTVTICAL_INVALID_ACCESS;
}
projects / platform / upstream / iotivity.git / blobdiff