1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641
use crate::{
enums::{DayOfMonth, DayOfWeek, Month, WeekOfMonth},
error::{InvalidOperationError, RequiredPropertyError},
schedule::Schedule,
settings::{PrincipalSettings, Settings},
};
use windows::core::ComInterface;
use windows::core::BSTR;
use windows::Win32::Foundation::VARIANT_BOOL;
use windows::Win32::System::Com::{
CoCreateInstance, CoInitializeEx, CoUninitialize, CLSCTX_ALL, COINIT_MULTITHREADED, VARIANT,
};
use windows::Win32::System::TaskScheduler::{
IAction, IActionCollection, IBootTrigger, IDailyTrigger, IEventTrigger, IExecAction,
IIdleTrigger, ILogonTrigger, IMonthlyDOWTrigger, IMonthlyTrigger, INetworkSettings, IPrincipal,
IRegistrationInfo, IRegistrationTrigger, IRepetitionPattern, ITaskDefinition, ITaskFolder,
ITaskService, ITaskSettings, ITimeTrigger, ITrigger, ITriggerCollection, IWeeklyTrigger,
TaskScheduler, TASK_ACTION_EXEC, TASK_LOGON_TYPE, TASK_RUNLEVEL_TYPE, TASK_TRIGGER_BOOT,
TASK_TRIGGER_DAILY, TASK_TRIGGER_EVENT, TASK_TRIGGER_IDLE, TASK_TRIGGER_LOGON,
TASK_TRIGGER_MONTHLY, TASK_TRIGGER_MONTHLYDOW, TASK_TRIGGER_REGISTRATION, TASK_TRIGGER_TIME,
TASK_TRIGGER_WEEKLY,
};
/* triggers */
/// Marker type for base [`ScheduleBuilder<Base>`]
pub struct Base {}
/// Marker type for boot [`ScheduleBuilder<Boot>`]
pub struct Boot {}
/// Marker type for a daily [`ScheduleBuilder<Daily>`]
pub struct Daily {}
/// Marker type for an event [`ScheduleBuilder<Event>`]
pub struct Event {}
/// Marker type for an idle [`ScheduleBuilder<Idle>`]
pub struct Idle {}
/// Marker type for a logon [`ScheduleBuilder<Logon>`]
pub struct Logon {}
/// Marker type for a monthly [`ScheduleBuilder<Monthly>`]
pub struct Monthly {}
/// Marker type for a monthly day of week [`ScheduleBuilder<MonthlyDOW>`]
pub struct MonthlyDOW {}
/// Marker type for registration [`ScheduleBuilder<Registration>`]
pub struct Registration {}
/// Marker type for a time [`ScheduleBuilder<Time>`]
pub struct Time {}
/// Marker type for a weekly [`ScheduleBuilder<Weekly>`]
pub struct Weekly {}
#[derive(Debug)]
#[doc(hidden)]
pub struct ScheduleBuilder<Frequency = Base> {
pub(crate) frequency: std::marker::PhantomData<Frequency>,
pub(crate) schedule: Schedule,
}
impl ScheduleBuilder<Base> {
/// Create a new base builder.
/// # Example
/// ```
/// use planif::schedule_builder::{ Base, ScheduleBuilder };
///
/// let builder: ScheduleBuilder<Base> = ScheduleBuilder::new().unwrap();
/// ```
pub fn new() -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
// On error of unsafe, CoUnintialize!
CoInitializeEx(None, COINIT_MULTITHREADED)?;
let task_service: ITaskService = CoCreateInstance(&TaskScheduler, None, CLSCTX_ALL)?;
task_service.Connect(
VARIANT::default(),
VARIANT::default(),
VARIANT::default(),
VARIANT::default(),
)?;
let task_folder: ITaskFolder = task_service.GetFolder(&BSTR::from("\\"))?;
let task_definition: ITaskDefinition = task_service.NewTask(0)?;
let triggers: ITriggerCollection = task_definition.Triggers()?;
let registration_info: IRegistrationInfo = task_definition.RegistrationInfo()?;
let actions: IActionCollection = task_definition.Actions()?;
let settings: ITaskSettings = task_definition.Settings()?;
Ok(Self {
frequency: std::marker::PhantomData::<Base>,
schedule: Schedule {
task_folder,
actions,
force_start_boundary: false,
registration_info,
settings,
task_service,
task_definition,
trigger: None,
triggers,
},
})
}
}
/// Creates a builder for a boot trigger.
///
/// # Example
///
/// ```
/// use planif::schedule_builder::{ Boot, ScheduleBuilder };
///
/// let builder: ScheduleBuilder<Boot> = ScheduleBuilder::new().unwrap()
/// .create_boot();
/// ```
pub fn create_boot(self) -> ScheduleBuilder<Boot> {
ScheduleBuilder::<Boot> {
frequency: std::marker::PhantomData::<Boot>,
schedule: self.schedule,
}
}
/// Creates a builder for a daily trigger.
///
/// # Example
///
/// ```
/// use planif::schedule_builder::{ Daily, ScheduleBuilder };
///
/// let builder: ScheduleBuilder<Daily> = ScheduleBuilder::new().unwrap()
/// .create_daily();
/// ```
pub fn create_daily(mut self) -> ScheduleBuilder<Daily> {
self.schedule.force_start_boundary = true;
ScheduleBuilder::<Daily> {
frequency: std::marker::PhantomData::<Daily>,
schedule: self.schedule,
}
}
/// Creates a builder for an event trigger.
///
/// # Example
///
/// ```
/// use planif::schedule_builder::{ Event, ScheduleBuilder };
///
/// let builder: ScheduleBuilder<Event> = ScheduleBuilder::new().unwrap()
/// .create_event();
/// ```
pub fn create_event(mut self) -> ScheduleBuilder<Event> {
self.schedule.force_start_boundary = true;
ScheduleBuilder::<Event> {
frequency: std::marker::PhantomData::<Event>,
schedule: self.schedule,
}
}
/// Creates a builder for an idle trigger.
///
/// # Example
///
/// ```
/// use planif::schedule_builder::{ Idle, ScheduleBuilder };
///
/// let builder: ScheduleBuilder<Idle> = ScheduleBuilder::new().unwrap()
/// .create_idle();
/// ```
pub fn create_idle(self) -> ScheduleBuilder<Idle> {
ScheduleBuilder::<Idle> {
frequency: std::marker::PhantomData::<Idle>,
schedule: self.schedule,
}
}
/// Creates a builder for a logon trigger.
///
/// # Example
///
/// ```
/// use planif::schedule_builder::{ Logon, ScheduleBuilder };
///
/// let builder: ScheduleBuilder<Logon> = ScheduleBuilder::new().unwrap()
/// .create_logon();
/// ```
pub fn create_logon(self) -> ScheduleBuilder<Logon> {
ScheduleBuilder::<Logon> {
frequency: std::marker::PhantomData::<Logon>,
schedule: self.schedule,
}
}
/// Creates a builder for a monthly trigger.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ Monthly, ScheduleBuilder };
///
/// let builder: ScheduleBuilder<Monthly> = ScheduleBuilder::new().unwrap()
/// .create_monthly();
/// ```
pub fn create_monthly(self) -> ScheduleBuilder<Monthly> {
ScheduleBuilder::<Monthly> {
frequency: std::marker::PhantomData::<Monthly>,
schedule: self.schedule,
}
}
/// Creates a builder for a monthly day of week trigger.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ MonthlyDOW, ScheduleBuilder };
///
/// let builder: ScheduleBuilder<MonthlyDOW> = ScheduleBuilder::new().unwrap()
/// .create_monthly_dow();
/// ```
pub fn create_monthly_dow(mut self) -> ScheduleBuilder<MonthlyDOW> {
self.schedule.force_start_boundary = true;
ScheduleBuilder::<MonthlyDOW> {
frequency: std::marker::PhantomData::<MonthlyDOW>,
schedule: self.schedule,
}
}
/// Creates a builder for a trigger that starts a task when the task is registered or updated.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ Registration, ScheduleBuilder };
///
/// let builder: ScheduleBuilder<Registration> = ScheduleBuilder::new().unwrap()
/// .create_registration();
/// ```
pub fn create_registration(self) -> ScheduleBuilder<Registration> {
ScheduleBuilder::<Registration> {
frequency: std::marker::PhantomData::<Registration>,
schedule: self.schedule,
}
}
/// Creates a builder for a time trigger.
///
/// # Example
///
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Time };
///
/// let builder: ScheduleBuilder<Time> = ScheduleBuilder::new().unwrap()
/// .create_time();
/// ```
pub fn create_time(mut self) -> ScheduleBuilder<Time> {
self.schedule.force_start_boundary = true;
ScheduleBuilder::<Time> {
frequency: std::marker::PhantomData::<Time>,
schedule: self.schedule,
}
}
/// Creates a builder for a weekly trigger.
///
/// # Example
///
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Weekly };
///
/// let builder: ScheduleBuilder<Weekly> = ScheduleBuilder::new().unwrap()
/// .create_weekly();
/// ```
pub fn create_weekly(self) -> ScheduleBuilder<Weekly> {
ScheduleBuilder::<Weekly> {
frequency: std::marker::PhantomData::<Weekly>,
schedule: self.schedule,
}
}
}
impl<Frequency> ScheduleBuilder<Frequency> {
/// Sets the task folder for this trigger.
/// For example, the root folder is "\\".
/// Do not use a backslash following the last folder name in the path.
/// _optional_
///
/// # Example
/// ```
/// use planif::schedule::Schedule;
/// use planif::schedule_builder::ScheduleBuilder;
///
/// let schedule: Schedule = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .in_folder("\\My Tasks").unwrap()
/// .build().unwrap();
/// ```
pub fn in_folder(mut self, folder: &str) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
// check if folder exists, if not make it
self.schedule.task_folder =
match self.schedule.task_service.GetFolder(&BSTR::from(folder)) {
Ok(x) => x,
Err(_) => self
.schedule
.task_service
.GetFolder(&BSTR::from("\\"))
.unwrap()
.CreateFolder(
&BSTR::from(folder.trim_start_matches('\\')),
VARIANT::default(),
)?,
};
}
Ok(self)
}
/// Creates the action to execute when the task is run.
///
/// See examples <https://github.com/mattrobineau/planif/tree/main/examples>
pub fn action(self, action: Action) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let i_action: IAction = self.schedule.actions.Create(TASK_ACTION_EXEC)?;
let i_exec_action: IExecAction = i_action.cast()?;
i_exec_action.SetPath(&action.path)?;
i_exec_action.SetId(&action.id)?;
i_exec_action.SetWorkingDirectory(&action.working_dir)?;
i_exec_action.SetArguments(&action.args)?;
}
Ok(self)
}
/// Sets the author for this trigger.
/// _optional_
///
/// # Example
/// ```
/// use planif::schedule::Schedule;
/// use planif::schedule_builder::ScheduleBuilder;
///
/// let schedule: Schedule = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("DailyTrigger", true).unwrap()
/// .author("Alice").unwrap()
/// .build().unwrap();
/// ```
pub fn author(self, author: &str) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
self.schedule
.registration_info
.SetAuthor(&BSTR::from(author))?;
}
Ok(self)
}
/// Returns the schedule
///
/// # Example
/// ```
/// use planif::schedule::Schedule;
/// use planif::schedule_builder::ScheduleBuilder;
///
/// let schedule: Schedule = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("DailyTrigger", true).unwrap()
/// .author("Alice").unwrap()
/// .build().unwrap();
/// ```
pub fn build(self) -> Result<Schedule, Box<dyn std::error::Error>> {
if self.schedule.trigger.is_none() {
return Err(Box::new(InvalidOperationError {
message: "Folder or trigger not set, cannot create scheduled task".to_string(),
}));
}
if self.schedule.force_start_boundary {
return Err(Box::new(RequiredPropertyError {
message: "The start boundary must be set for this trigger type".to_string(),
}));
}
Ok(self.schedule)
}
/// Sets the description for this trigger.
/// _optional_
///
/// # Example
/// ```
/// use planif::schedule::Schedule;
/// use planif::schedule_builder::ScheduleBuilder;
///
/// let schedule: Schedule = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("DailyTrigger", true).unwrap()
/// .description("This is my trigger").unwrap()
/// .build().unwrap();
/// ```
pub fn description(self, description: &str) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
self.schedule
.registration_info
.SetDescription(&BSTR::from(description))?;
}
Ok(self)
}
/// Closes the COM library on the current thread, unloads all DLLs loaded
/// by the thread, frees any other resources that the thread maintains, and
/// forces all RPC connections on the thread to close.
pub fn uninitialize(self) {
unsafe {
CoUninitialize();
}
}
/// The amount of time that is allowed to complete the task.
/// The format for this string is PnYnMnDTnHnMnS, where nY is the number of years,
/// nM is the number of months, nD is the number of days, 'T' is the date/time separator,
/// nH is the number of hours, nM is the number of minutes, and nS is the number of
/// seconds (for example, PT5M specifies 5 minutes and P1M4DT2H5M specifies one month,
/// four days, two hours, and five minutes). A value of PT0S will enable the task to run indefinitely.
///
/// # Example
/// ```
/// use planif::schedule::Schedule;
/// use planif::schedule_builder::ScheduleBuilder;
///
/// let schedule: Schedule = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("MyTrigger", true).unwrap()
/// .description("This is my trigger").unwrap()
/// .execution_time_limit("PT5M").unwrap()
/// .build().unwrap();
/// ```
pub fn execution_time_limit(
self,
time_limit: &str,
) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
trigger.SetExecutionTimeLimit(&BSTR::from(time_limit))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Specifies the date and time when the trigger is activated. This call is required on
/// Calendar triggers and Time Triggers.
/// `start_boundary`'s `start` parameter takes a rfc3339 formatted string (ie: 2007-01-01T08:00:00).
///
/// ## References
/// <https://docs.microsoft.com/en-us/windows/win32/taskschd/taskschedulerschema-startboundary-triggerbasetype-element>
/// <https://datatracker.ietf.org/doc/html/rfc3339>
///
/// # Example
/// ```
/// use planif::schedule::Schedule;
/// use planif::schedule_builder::ScheduleBuilder;
///
/// let schedule: Schedule = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("DailyTrigger", true).unwrap()
/// .description("This is my trigger").unwrap()
/// .start_boundary("2007-01-01T08:00:00").unwrap()
/// .build().unwrap();
/// ```
pub fn start_boundary(mut self, start: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
trigger.SetStartBoundary(&BSTR::from(start))?;
}
self.schedule.force_start_boundary = false;
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Specifies the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated.
/// `end_boundary`'s `end` parameter takes an rfc3339 formatted string (ie: 2007-01-01T08:00:00)
///
/// ## References
/// <https://docs.microsoft.com/en-us/windows/win32/taskschd/taskschedulerschema-endboundary-triggerbasetype-element>
/// <https://datatracker.ietf.org/doc/html/rfc3339>
///
/// # Example
/// ```
/// use planif::schedule::Schedule;
/// use planif::schedule_builder::ScheduleBuilder;
///
/// let schedule: Schedule = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("DailyTrigger", true).unwrap()
/// .description("This is my trigger").unwrap()
/// .end_boundary("2007-01-01T08:00:00").unwrap()
/// .build().unwrap();
/// ```
pub fn end_boundary(self, end: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
trigger.SetEndBoundary(&BSTR::from(end))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Sets the repetition duration for a task.
/// If you specify a repetition duration for a task, you must also specify the repetition interval.
/// If you register a task that contains a trigger with a repetition interval equal to one minute
/// and a repetition duration equal to four minutes, the task will be launched five times. The five
/// repetitions can be defined by the following pattern.
///
/// A task starts at the beginning of the first minute.
/// - The next task starts at the end of the first minute.
/// - The next task starts at the end of the second minute.
/// - The next task starts at the end of the third minute.
/// - The next task starts at the end of the fourth minute.
///
/// # Parameters
/// ## duration
/// How long the pattern is repeated. The format for this string is PnYnMnDTnHnMnS, where nY is
/// the number of years, nM is the number of months, nD is the number of days, 'T' is the date/time
/// separator, nH is the number of hours, nM is the number of minutes, and nS is the number of seconds
/// (for example, PT5M specifies 5 minutes and P1M4DT2H5M specifies one month, four days, two hours,
/// and five minutes). The minimum time allowed is one minute.
///
/// ## interval
/// The amount of time between each restart of the task. The format for this string is
/// P<days>DT<hours>H<minutes>M<seconds>S (for example, "PT5M" is 5 minutes, "PT1H" is 1 hour, and "PT20M"
/// is 20 minutes). The maximum time allowed is 31 days, and the minimum time allowed is 1 minute.
///
/// # stop_at_duration_end
/// A Boolean value that indicates if a running instance of the task is stopped at the end of the repetition
/// pattern duration.
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/repetitionpattern>
///
/// # Example
/// ```
/// use planif::schedule::Schedule;
/// use planif::schedule_builder::ScheduleBuilder;
///
/// let schedule: Schedule = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("DailyTrigger", true).unwrap()
/// .description("This is my trigger").unwrap()
/// .repetition("PT5M", "PT1H", true).unwrap()
/// .build().unwrap();
/// ```
pub fn repetition(
self,
duration: &str,
interval: &str,
stop_at_duration_end: bool,
) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
let repetition: IRepetitionPattern = trigger.Repetition()?;
repetition.SetDuration(&BSTR::from(duration))?;
repetition.SetInterval(&BSTR::from(interval))?;
repetition.SetStopAtDurationEnd(VARIANT_BOOL::from(stop_at_duration_end))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Sets the task's principal
/// When specifying an account, remember to properly use the double backslash in code to specify the
/// domain and user name. For example, use DOMAIN\\UserName to specify a value for the UserId property.
///
/// # reference
/// <https://docs.microsoft.com/en-us/windows/win32/taskschd/principal>
///
/// # Example
/// ```
/// use planif::settings::{ PrincipalSettings, RunLevel, LogonType };
/// use planif::schedule::Schedule;
/// use planif::schedule_builder::ScheduleBuilder;
///
/// let settings = PrincipalSettings {
/// display_name: "Planif".to_string(),
/// group_id: None,
/// id: "MyPrincipalId".to_string(),
/// logon_type: LogonType::ServiceAccount,
/// run_level: RunLevel::LUA,
/// user_id: Some("MyServiceAccount".to_string()),
/// };
///
/// let schedule: Schedule = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("DailyTrigger", true).unwrap()
/// .description("This is my trigger").unwrap()
/// .principal(settings).unwrap()
/// .build().unwrap();
/// ```
pub fn principal(
self,
settings: PrincipalSettings,
) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let principal: IPrincipal = self.schedule.task_definition.Principal()?;
principal.SetDisplayName(&BSTR::from(settings.display_name))?;
if settings.group_id.is_some() && settings.user_id.is_some() {
return Err(Box::new(InvalidOperationError {
message: "Invalid operation: group_id and user_id are mutually exclusive and cannot both be set."
.to_string(),
}));
} else if let Some(gid) = settings.group_id {
principal.SetGroupId(&BSTR::from(gid))?;
} else if let Some(uid) = settings.user_id {
principal.SetUserId(&BSTR::from(uid))?;
}
principal.SetId(&BSTR::from(settings.id))?;
principal.SetLogonType(TASK_LOGON_TYPE(settings.logon_type as i32))?;
principal.SetRunLevel(TASK_RUNLEVEL_TYPE(settings.run_level as i32))?;
self.schedule.task_definition.SetPrincipal(&principal)?;
Ok(self)
}
}
/// Sets the Task's settings.
/// # Example
/// ```
/// use planif::settings::{ Settings };
/// use planif::schedule::Schedule;
/// use planif::schedule_builder::ScheduleBuilder;
///
/// let settings = Settings::new();
/// settings.allow_demand_start = Some(true);
///
/// let schedule: Schedule = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("DailyTrigger", true).unwrap()
/// .description("This is my trigger").unwrap()
/// .principal(settings).unwrap()
/// .build()
/// .settings(settings)
/// .unwrap();
/// ```
pub fn settings(self, settings: Settings) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let task_settings: ITaskSettings = self.schedule.task_definition.Settings()?;
// Handle idle settings
if let Some(s) = settings.idle_settings {
let idle_settings = task_settings.IdleSettings()?;
#[allow(deprecated)]
if let Some(setting) = s.idle_duration {
idle_settings.SetIdleDuration(&BSTR::from(setting))?;
}
if let Some(setting) = s.restart_on_idle {
idle_settings.SetRestartOnIdle(VARIANT_BOOL::from(setting))?;
}
if let Some(setting) = s.stop_on_idle_end {
idle_settings.SetStopOnIdleEnd(VARIANT_BOOL::from(setting))?;
}
#[allow(deprecated)]
if let Some(setting) = s.wait_timeout {
idle_settings.SetWaitTimeout(&BSTR::from(setting))?;
}
task_settings.SetIdleSettings(&idle_settings)?;
}
// Handle Network Settings
if let Some(s) = settings.network_settings {
let network_settings: INetworkSettings = task_settings.NetworkSettings()?;
network_settings.SetId(&BSTR::from(s.id))?;
network_settings.SetName(&BSTR::from(s.name))?;
task_settings.SetNetworkSettings(&network_settings)?;
}
// Handle settings
if let Some(s) = settings.allow_demand_start {
task_settings.SetAllowDemandStart(VARIANT_BOOL::from(s))?;
}
if let Some(s) = settings.allow_hard_terminate {
task_settings.SetAllowHardTerminate(VARIANT_BOOL::from(s))?;
}
if let Some(s) = settings.compatibility {
task_settings.SetCompatibility(s.into())?;
}
if let Some(s) = settings.delete_expired_task_after {
task_settings.SetDeleteExpiredTaskAfter(&BSTR::from(s))?;
}
if let Some(s) = settings.disallow_start_if_on_batteries {
task_settings.SetDisallowStartIfOnBatteries(VARIANT_BOOL::from(s))?;
}
if let Some(s) = settings.enabled {
task_settings.SetEnabled(VARIANT_BOOL::from(s))?;
}
if let Some(s) = settings.execution_time_limit {
task_settings.SetExecutionTimeLimit(&BSTR::from(s))?;
}
if let Some(s) = settings.hidden {
task_settings.SetHidden(VARIANT_BOOL::from(s))?;
}
if let Some(s) = settings.multiple_instances_policy {
task_settings.SetMultipleInstances(s.into())?;
}
if let Some(s) = settings.priority {
task_settings.SetPriority(s)?;
}
if let Some(s) = settings.restart_count {
task_settings.SetRestartCount(s)?;
}
if let Some(s) = settings.restart_interval {
task_settings.SetRestartInterval(&BSTR::from(s))?;
}
if let Some(s) = settings.run_only_if_idle {
task_settings.SetRunOnlyIfIdle(VARIANT_BOOL::from(s))?;
}
if let Some(s) = settings.run_only_if_network_available {
task_settings.SetRunOnlyIfNetworkAvailable(VARIANT_BOOL::from(s))?;
}
if let Some(s) = settings.start_when_available {
task_settings.SetStartWhenAvailable(VARIANT_BOOL::from(s))?;
}
if let Some(s) = settings.stop_if_going_on_batteries {
task_settings.SetStopIfGoingOnBatteries(VARIANT_BOOL::from(s))?;
}
if let Some(s) = settings.wake_to_run {
task_settings.SetWakeToRun(VARIANT_BOOL::from(s))?;
}
if let Some(s) = settings.xml_text {
task_settings.SetXmlText(&BSTR::from(s))?;
}
self.schedule.task_definition.SetSettings(&task_settings)?;
}
Ok(self)
}
}
impl ScheduleBuilder<Boot> {
/// Create a task that is started when the operating system is booted,
/// and boot trigger tasks are set to start when the Task Scheduler service starts.
/// Only a member of the Administrators group can create a task with a boot trigger.
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/boottrigger>
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Boot };
///
/// let builder: ScheduleBuilder<Boot> = ScheduleBuilder::new().unwrap()
/// .create_boot()
/// .trigger("MyTrigger", true).unwrap();
/// ```
pub fn trigger(mut self, id: &str, enabled: bool) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let trigger = self.schedule.triggers.Create(TASK_TRIGGER_BOOT)?;
let i_boot_trigger: IBootTrigger = trigger.cast::<IBootTrigger>()?;
i_boot_trigger.SetId(&BSTR::from(id))?;
i_boot_trigger.SetEnabled(VARIANT_BOOL::from(enabled))?;
// Default start boundary to now()
self.schedule.trigger = Some(i_boot_trigger.cast::<ITrigger>()?);
}
Ok(self)
}
/// Specifies a value that indicates the amount of time between when the user logs on and when the task is started.
/// The format for this string is P<days>DT<hours>H<minutes>M<seconds>S (for example, P2DT5S is a 2 day, 5 second delay).
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/logontrigger-delay>
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Boot };
///
/// let builder: ScheduleBuilder<Boot> = ScheduleBuilder::new().unwrap()
/// .create_boot()
/// .trigger("MyTrigger", true).unwrap()
/// .delay("P2DT5S").unwrap();
/// ```
pub fn delay(self, delay: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
let i_boot_trigger: IBootTrigger = trigger.cast::<IBootTrigger>()?;
i_boot_trigger.SetDelay(&BSTR::from(delay))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
}
impl ScheduleBuilder<Daily> {
/// Creates a daily trigger
/// The time of day that the task is started is set by the start_boundary method.
/// If `start_boundary()` is not set, it will default to `now` when the `schedule` is `registered()`
///An interval of 1 produces a daily schedule. An interval of 2 produces an every other day schedule and so on.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Daily };
///
/// let builder: ScheduleBuilder<Daily> = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("MyTrigger", true).unwrap();
/// ```
pub fn trigger(mut self, id: &str, enabled: bool) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let trigger = self.schedule.triggers.Create(TASK_TRIGGER_DAILY)?;
let i_daily_trigger: IDailyTrigger = trigger.cast::<IDailyTrigger>()?;
i_daily_trigger.SetId(&BSTR::from(id))?;
i_daily_trigger.SetEnabled(VARIANT_BOOL::from(enabled))?;
self.schedule.trigger = Some(i_daily_trigger.cast::<ITrigger>()?);
}
Ok(self)
}
/// Sets the interval for days.
/// ie: An interval of 1 produces a daily schedule. An interval of 2 produces an every-other day schedule. Etc.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Daily };
///
/// let builder: ScheduleBuilder<Daily> = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("MyTrigger", true).unwrap()
/// .days_interval(1).unwrap();
/// ```
pub fn days_interval(self, days: i16) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
unsafe {
let i_daily_trigger: IDailyTrigger = i_trigger.cast::<IDailyTrigger>()?;
i_daily_trigger.SetDaysInterval(days)?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Specifies the delay time that is randomly added to the start time of the trigger.
/// The format for this string is P<days>DT<hours>H<minutes>M<seconds>S (for example, P2DT5S is a 2 day, 5 second delay).
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/taskschedulerschema-randomdelay-timetriggertype-element>
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Daily };
///
/// let builder: ScheduleBuilder<Daily> = ScheduleBuilder::new().unwrap()
/// .create_daily()
/// .trigger("MyTrigger", true).unwrap()
/// .random_delay("P2DT5S").unwrap();
/// ```
pub fn random_delay(self, delay: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
unsafe {
let i_daily_trigger: IDailyTrigger = i_trigger.cast::<IDailyTrigger>()?;
i_daily_trigger.SetRandomDelay(&BSTR::from(delay))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
}
impl ScheduleBuilder<Event> {
/// Specifies a value that indicates the amount of time between when the user logs on and when the task is started.
/// The format for this string is P<days>DT<hours>H<minutes>M<seconds>S (for example, P2DT5S is a 2 day, 5 second delay).
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/eventtrigger-delay>
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Event };
///
/// let builder: ScheduleBuilder<Event> = ScheduleBuilder::new().unwrap()
/// .create_event()
/// .trigger("MyTrigger", true).unwrap()
/// .delay("P2DT5S").unwrap();
/// ```
pub fn delay(self, delay: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
let i_event_trigger: IEventTrigger = trigger.cast::<IEventTrigger>()?;
i_event_trigger.SetDelay(&BSTR::from(delay))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Specifies a query string that identifies the event that fires the trigger.
///
/// See Event Selection:
/// <https://docs.microsoft.com/en-us/previous-versions//aa385231(v=vs.85)>
///
/// See Subscribing to Events: <https://docs.microsoft.com/en-us/windows/win32/wes/subscribing-to-events>
pub fn subscription(self, query: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
let i_event_trigger: IEventTrigger = trigger.cast::<IEventTrigger>()?;
i_event_trigger.SetSubscription(&BSTR::from(query))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Create an event trigger.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Event };
///
/// let builder: ScheduleBuilder<Event> = ScheduleBuilder::new().unwrap()
/// .create_event()
/// .trigger("MyTrigger", true).unwrap();
/// ```
pub fn trigger(mut self, id: &str, enabled: bool) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let trigger = self.schedule.triggers.Create(TASK_TRIGGER_EVENT)?;
let i_event_trigger: IEventTrigger = trigger.cast::<IEventTrigger>()?;
i_event_trigger.SetId(&BSTR::from(id))?;
i_event_trigger.SetEnabled(VARIANT_BOOL::from(enabled))?;
self.schedule.trigger = Some(i_event_trigger.cast::<ITrigger>()?);
}
Ok(self)
}
/// Specifies a collection of named XPath queries. Each name-value pair in the collection
/// defines a unique name for a property value of the event that triggers the event trigger.
/// The property value of the event is defined as an XPath event query.
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/eventtrigger-valuequeries>
pub fn value_queries(
self,
queries: Vec<(&str, &str)>,
) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
let i_event_trigger: IEventTrigger = trigger.cast::<IEventTrigger>()?;
let i_task_named_value_collection = i_event_trigger.ValueQueries()?;
for (name, value) in queries {
i_task_named_value_collection.Create(&BSTR::from(name), &BSTR::from(value))?;
}
i_event_trigger.SetValueQueries(&i_task_named_value_collection)?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
}
impl ScheduleBuilder<Idle> {
/// Create an idle trigger.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Idle };
///
/// let builder: ScheduleBuilder<Idle> = ScheduleBuilder::new().unwrap()
/// .create_idle()
/// .trigger("MyTrigger", true).unwrap();
/// ```
pub fn trigger(mut self, id: &str, enabled: bool) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let trigger = self.schedule.triggers.Create(TASK_TRIGGER_IDLE)?;
let i_idle_trigger: IIdleTrigger = trigger.cast::<IIdleTrigger>()?;
i_idle_trigger.SetId(&BSTR::from(id))?;
i_idle_trigger.SetEnabled(VARIANT_BOOL::from(enabled))?;
self.schedule.trigger = Some(i_idle_trigger.cast::<ITrigger>()?);
}
Ok(self)
}
}
impl ScheduleBuilder<Logon> {
/// Create a logon trigger.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Logon };
///
/// let builder: ScheduleBuilder<Logon> = ScheduleBuilder::new().unwrap()
/// .create_logon()
/// .trigger("MyTrigger", true).unwrap();
/// ```
pub fn trigger(mut self, id: &str, enabled: bool) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let trigger = self.schedule.triggers.Create(TASK_TRIGGER_LOGON)?;
let i_logon_trigger: ILogonTrigger = trigger.cast::<ILogonTrigger>()?;
i_logon_trigger.SetId(&BSTR::from(id))?;
i_logon_trigger.SetEnabled(VARIANT_BOOL::from(enabled))?;
self.schedule.trigger = Some(i_logon_trigger.cast::<ITrigger>()?);
}
Ok(self)
}
/// Specifies a value that indicates the amount of time between when the user logs on and when the task is started.
/// The format for this string is P<days>DT<hours>H<minutes>M<seconds>S (for example, P2DT5S is a 2 day, 5 second delay).
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/logontrigger-delay>
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Logon };
///
/// let builder: ScheduleBuilder<Logon> = ScheduleBuilder::new().unwrap()
/// .create_logon()
/// .trigger("MyTrigger", true).unwrap()
/// .delay("P2DT5S").unwrap();
/// ```
pub fn delay(self, delay: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
let i_logon_trigger: ILogonTrigger = trigger.cast::<ILogonTrigger>()?;
i_logon_trigger.SetDelay(&BSTR::from(delay))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator".
/// _required_
/// This property can be in one of the following formats:
/// - User name or SID: The task is started when the user logs on to the computer.
/// - NULL: The task is started when any user logs on to the computer.
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/logontrigger-userid>
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Logon };
///
/// let builder: ScheduleBuilder<Logon> = ScheduleBuilder::new().unwrap()
/// .create_logon()
/// .trigger("MyTrigger", true).unwrap()
/// .user_id("MyDomain\\User").unwrap();
/// ```
pub fn user_id(self, id: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
let i_logon_trigger: ILogonTrigger = trigger.cast::<ILogonTrigger>()?;
i_logon_trigger.SetUserId(&BSTR::from(id))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
}
impl ScheduleBuilder<Monthly> {
/// Set the days of the month during which the task runs.
/// # Example
/// ```
/// use planif::enums::DayOfMonth;
/// use planif::schedule_builder::{ ScheduleBuilder, Monthly };
///
/// let builder: ScheduleBuilder<Monthly> = ScheduleBuilder::new().unwrap()
/// .create_monthly()
/// .trigger("MyTrigger", true).unwrap()
/// .days_of_month(vec![DayOfMonth::Day(1), DayOfMonth::Day(15),
/// DayOfMonth::Day(31)]).unwrap();
/// ```
pub fn days_of_month(self, days: Vec<DayOfMonth>) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
let is_out_of_bounds = days.iter().any(|x| match &x {
DayOfMonth::Day(int) => int < &1 || int > &31,
DayOfMonth::Last => false,
});
if is_out_of_bounds {
return Err(Box::new(InvalidOperationError {
message:
"Index out of bounds. Days of month must be between 1 and 31 inclusively."
.to_string(),
}));
}
let bitwise = days.into_iter().fold(0, |acc, item| {
let day: i32 = item.into();
acc + day
});
unsafe {
let i_monthly_trigger: IMonthlyTrigger = i_trigger.cast::<IMonthlyTrigger>()?;
i_monthly_trigger.SetDaysOfMonth(bitwise)?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Set the months of the year during which the task runs.
/// # Example
/// ```
/// use planif::enums::Month;
/// use planif::schedule_builder::{ ScheduleBuilder, Monthly };
///
/// let builder: ScheduleBuilder<Monthly> = ScheduleBuilder::new().unwrap()
/// .create_monthly()
/// .trigger("MyTrigger", true).unwrap()
/// .months_of_year(vec![Month::January, Month::June, Month::December]).unwrap();
/// ```
pub fn months_of_year(self, months: Vec<Month>) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
let bitwise: i16 = months.into_iter().fold(0, |acc, item| acc + item as i16);
unsafe {
let i_monthly_trigger: IMonthlyTrigger = i_trigger.cast::<IMonthlyTrigger>()?;
i_monthly_trigger.SetMonthsOfYear(bitwise)?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Specifies the delay time that is randomly added to the start time of the trigger.
/// The format for this string is P<days>DT<hours>H<minutes>M<seconds>S (for example, P2DT5S is a 2 day, 5 second delay).
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/taskschedulerschema-randomdelay-timetriggertype-element>
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Monthly };
///
/// let builder: ScheduleBuilder<Monthly> = ScheduleBuilder::new().unwrap()
/// .create_monthly()
/// .trigger("MyTrigger", true).unwrap()
/// .random_delay("P2DT5S").unwrap();
/// ```
pub fn random_delay(self, delay: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
unsafe {
let i_monthly_trigger: IMonthlyTrigger = i_trigger.cast::<IMonthlyTrigger>()?;
i_monthly_trigger.SetRandomDelay(&BSTR::from(delay))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Sets the task to be run on the last day of the month, regardless of the actual date of
/// that day.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Monthly };
///
/// let builder: ScheduleBuilder<Monthly> = ScheduleBuilder::new().unwrap()
/// .create_monthly()
/// .trigger("MyTrigger", true).unwrap()
/// .run_on_last_day(true).unwrap();
/// ```
pub fn run_on_last_day(self, is_run: bool) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
unsafe {
let i_monthly_trigger: IMonthlyTrigger = i_trigger.cast::<IMonthlyTrigger>()?;
i_monthly_trigger.SetRunOnLastDayOfMonth(VARIANT_BOOL::from(is_run))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Creates a trigger based on a monthly schedule, for example, the task starts on specific
/// days of specific months
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Monthly };
///
/// let builder: ScheduleBuilder<Monthly> = ScheduleBuilder::new().unwrap()
/// .create_monthly()
/// .trigger("MyTrigger", true).unwrap();
/// ```
pub fn trigger(mut self, id: &str, enabled: bool) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
self.schedule.force_start_boundary = true;
let trigger = self.schedule.triggers.Create(TASK_TRIGGER_MONTHLY)?;
let i_monthly_trigger: IMonthlyTrigger = trigger.cast::<IMonthlyTrigger>()?;
i_monthly_trigger.SetId(&BSTR::from(id))?;
i_monthly_trigger.SetEnabled(VARIANT_BOOL::from(enabled))?;
self.schedule.trigger = Some(i_monthly_trigger.cast::<ITrigger>()?);
}
Ok(self)
}
}
impl ScheduleBuilder<MonthlyDOW> {
/// Sets the days of the week during which the task runs.
///
/// # Example
/// ```
/// use planif::enums::DayOfWeek;
/// use planif::schedule_builder::{ ScheduleBuilder, MonthlyDOW };
///
/// let builder: ScheduleBuilder<MonthlyDOW> = ScheduleBuilder::new().unwrap()
/// .create_monthly_dow()
/// .trigger("MonthlyDOWTrigger", true).unwrap()
/// .days_of_week(vec![DayOfWeek::Sunday, DayOfWeek::Thursday]).unwrap();
/// ```
pub fn days_of_week(self, days: Vec<DayOfWeek>) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
let bitwise: i16 = days.into_iter().fold(0, |acc, item| acc + item as i16);
unsafe {
let i_monthly_dow_trigger: IMonthlyDOWTrigger =
trigger.cast::<IMonthlyDOWTrigger>()?;
i_monthly_dow_trigger.SetDaysOfWeek(bitwise)?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Set the months of the year during which the task runs.
/// # Example
/// ```
/// use planif::enums::Month;
/// use planif::schedule_builder::{ ScheduleBuilder, MonthlyDOW };
///
/// let builder: ScheduleBuilder<MonthlyDOW> = ScheduleBuilder::new().unwrap()
/// .create_monthly_dow()
/// .trigger("MyTrigger", true).unwrap()
/// .months_of_year(vec![Month::January, Month::June, Month::December]).unwrap();
/// ```
pub fn months_of_year(self, months: Vec<Month>) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
let bitwise: i16 = months.into_iter().fold(0, |acc, item| acc + item as i16);
unsafe {
let i_monthly_dow_trigger: IMonthlyDOWTrigger =
i_trigger.cast::<IMonthlyDOWTrigger>()?;
i_monthly_dow_trigger.SetMonthsOfYear(bitwise)?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Specifies the delay time that is randomly added to the start time of the trigger.
/// The format for this string is P<days>DT<hours>H<minutes>M<seconds>S (for example, P2DT5S is a 2 day, 5 second delay).
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/taskschedulerschema-randomdelay-timetriggertype-element>
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, MonthlyDOW };
///
/// let builder: ScheduleBuilder<MonthlyDOW> = ScheduleBuilder::new().unwrap()
/// .create_monthly_dow()
/// .trigger("MyTrigger", true).unwrap()
/// .random_delay("P2DT5S").unwrap();
/// ```
pub fn random_delay(self, delay: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
unsafe {
let i_monthly_dow_trigger: IMonthlyDOWTrigger =
i_trigger.cast::<IMonthlyDOWTrigger>()?;
i_monthly_dow_trigger.SetRandomDelay(&BSTR::from(delay))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Sets the task to be run on the last day of the month, regardless of the actual date of
/// that day.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, MonthlyDOW };
///
/// let builder: ScheduleBuilder<MonthlyDOW> = ScheduleBuilder::new().unwrap()
/// .create_monthly_dow()
/// .trigger("MyTrigger", true).unwrap()
/// .run_on_last_week(true).unwrap();
/// ```
pub fn run_on_last_week(self, is_run: bool) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
let i_monthly_dow_trigger: IMonthlyDOWTrigger =
trigger.cast::<IMonthlyDOWTrigger>()?;
i_monthly_dow_trigger.SetRunOnLastWeekOfMonth(VARIANT_BOOL::from(is_run))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Sets the weeks of the month during which the task runs.
///
/// # Example
/// ```
/// use planif::enums::WeekOfMonth;
/// use planif::schedule_builder::{ ScheduleBuilder, MonthlyDOW };
///
/// let builder: ScheduleBuilder<MonthlyDOW> = ScheduleBuilder::new().unwrap()
/// .create_monthly_dow()
/// .trigger("MyTrigger", true).unwrap()
/// .weeks_of_month(vec![WeekOfMonth::Third]).unwrap();
/// ```
pub fn weeks_of_month(
self,
weeks: Vec<WeekOfMonth>,
) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
let bitwise: i16 = weeks.into_iter().fold(0, |acc, item| acc + item as i16);
unsafe {
let i_monthly_dow_trigger: IMonthlyDOWTrigger =
trigger.cast::<IMonthlyDOWTrigger>()?;
i_monthly_dow_trigger.SetWeeksOfMonth(bitwise)?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Creates a trigger that starts a task on a monthly day-of-week schedule. For example, the
/// task starts on every first Thursday, May through October.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, MonthlyDOW };
///
/// let builder: ScheduleBuilder<MonthlyDOW> = ScheduleBuilder::new().unwrap()
/// .create_monthly_dow()
/// .trigger("MyTrigger", true).unwrap();
/// ```
pub fn trigger(mut self, id: &str, enabled: bool) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let trigger = self.schedule.triggers.Create(TASK_TRIGGER_MONTHLYDOW)?;
let i_monthly_dow_trigger: IMonthlyDOWTrigger = trigger.cast::<IMonthlyDOWTrigger>()?;
i_monthly_dow_trigger.SetId(&BSTR::from(id))?;
i_monthly_dow_trigger.SetEnabled(VARIANT_BOOL::from(enabled))?;
self.schedule.trigger = Some(i_monthly_dow_trigger.cast::<ITrigger>()?);
}
Ok(self)
}
}
impl ScheduleBuilder<Registration> {
/// Specifies a value that indicates the amount of time between when the user logs on and when the task is started.
/// The format for this string is P<days>DT<hours>H<minutes>M<seconds>S (for example, P2DT5S is a 2 day, 5 second delay).
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/registrationtrigger-delay>
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Registration };
///
/// let builder: ScheduleBuilder<Registration> = ScheduleBuilder::new().unwrap()
/// .create_registration()
/// .trigger("MyTrigger", true).unwrap()
/// .delay("PT5M").unwrap();
/// ```
pub fn delay(self, delay: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(trigger) = &self.schedule.trigger {
unsafe {
let i_registration_trigger: IRegistrationTrigger =
trigger.cast::<IRegistrationTrigger>()?;
i_registration_trigger.SetDelay(&BSTR::from(delay))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Creates a trigger that starts a task when the task is registered or updated.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Registration };
///
/// let builder: ScheduleBuilder<Registration> = ScheduleBuilder::new().unwrap()
/// .create_registration()
/// .trigger("MyTrigger", true).unwrap();
/// ```
pub fn trigger(mut self, id: &str, enabled: bool) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let trigger = self.schedule.triggers.Create(TASK_TRIGGER_REGISTRATION)?;
let i_registration_trigger: IRegistrationTrigger =
trigger.cast::<IRegistrationTrigger>()?;
i_registration_trigger.SetId(&BSTR::from(id))?;
i_registration_trigger.SetEnabled(VARIANT_BOOL::from(enabled))?;
self.schedule.trigger = Some(i_registration_trigger.cast::<ITrigger>()?);
}
Ok(self)
}
}
impl ScheduleBuilder<Time> {
/// Creates a time trigger
/// It is important to note that a time trigger is different from other time-based triggers in that
/// it is fired when the trigger is activated by its start boundary. Other time-based triggers are
/// activated by their start boundary, but they do not start performing their actions
/// until a scheduled date is reached.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Time };
///
/// let builder: ScheduleBuilder<Time> = ScheduleBuilder::new().unwrap()
/// .create_time()
/// .trigger("MyTrigger", true).unwrap();
/// ```
pub fn trigger(mut self, id: &str, enabled: bool) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let trigger = self.schedule.triggers.Create(TASK_TRIGGER_TIME)?;
let i_time_trigger: ITimeTrigger = trigger.cast::<ITimeTrigger>()?;
i_time_trigger.SetId(&BSTR::from(id))?;
i_time_trigger.SetEnabled(VARIANT_BOOL::from(enabled))?;
self.schedule.trigger = Some(i_time_trigger.cast::<ITrigger>()?);
}
Ok(self)
}
/// Specifies the delay time that is randomly added to the start time of the trigger.
/// The format for this string is P<days>DT<hours>H<minutes>M<seconds>S (for example, P2DT5S is a 2 day, 5 second delay).
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/taskschedulerschema-randomdelay-timetriggertype-element>
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Time };
///
/// let builder: ScheduleBuilder<Time> = ScheduleBuilder::new().unwrap()
/// .create_time()
/// .trigger("MyTrigger", true).unwrap()
/// .random_delay("P2DT5S").unwrap();
/// ```
pub fn random_delay(self, delay: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
unsafe {
let i_time_trigger: ITimeTrigger = i_trigger.cast::<ITimeTrigger>()?;
i_time_trigger.SetRandomDelay(&BSTR::from(delay))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
}
impl ScheduleBuilder<Weekly> {
/// Creates a trigger that starts a task based on a weekly schedule. For example, the task
/// starts at 8h00 on a specific day of the week every week or every other week.
///
/// # Example
/// ```
/// use planif::schedule_builder::{ ScheduleBuilder, Weekly };
///
/// let builder: ScheduleBuilder<Weekly> = ScheduleBuilder::new().unwrap()
/// .create_weekly()
/// .trigger("MyTrigger", true).unwrap();
/// ```
pub fn trigger(mut self, id: &str, enabled: bool) -> Result<Self, Box<dyn std::error::Error>> {
unsafe {
let trigger = self.schedule.triggers.Create(TASK_TRIGGER_WEEKLY)?;
let i_weekly_trigger: IWeeklyTrigger = trigger.cast::<IWeeklyTrigger>()?;
i_weekly_trigger.SetId(&BSTR::from(id))?;
i_weekly_trigger.SetEnabled(VARIANT_BOOL::from(enabled))?;
self.schedule.trigger = Some(i_weekly_trigger.cast::<ITrigger>()?);
}
Ok(self)
}
/// Sets the days of the week during which the task runs.
///
/// # Example
/// ```
/// use planif::enums::DayOfWeek;
/// use planif::schedule_builder::{ ScheduleBuilder, Weekly };
///
/// let builder: ScheduleBuilder<Weekly> = ScheduleBuilder::new().unwrap()
/// .create_weekly()
/// .trigger("MyTrigger", true).unwrap()
/// .days_of_week(vec![DayOfWeek::Sunday, DayOfWeek::Thursday]).unwrap();
/// ```
pub fn days_of_week(self, days: Vec<DayOfWeek>) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
let bitwise: i16 = days.into_iter().fold(0, |acc, item| acc + item as i16);
unsafe {
let i_weekly_trigger: IWeeklyTrigger = i_trigger.cast::<IWeeklyTrigger>()?;
i_weekly_trigger.SetDaysOfWeek(bitwise)?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Sets the interval between the weeks in the schedule.
/// For example settings to 1 runs every week; setting to 2 runs every other week.
///
/// # Example
/// ```
/// use planif::enums::DayOfWeek;
/// use planif::schedule_builder::{ ScheduleBuilder, Weekly };
///
/// let builder: ScheduleBuilder<Weekly> = ScheduleBuilder::new().unwrap()
/// .create_weekly()
/// .trigger("MyTrigger", true).unwrap()
/// .weeks_interval(1).unwrap();
/// ```
pub fn weeks_interval(self, weeks: i16) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
unsafe {
let i_weekly_trigger: IWeeklyTrigger = i_trigger.cast::<IWeeklyTrigger>()?;
i_weekly_trigger.SetWeeksInterval(weeks)?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
/// Specifies the delay time that is randomly added to the start time of the trigger.
/// The format for this string is P<days>DT<hours>H<minutes>M<seconds>S (for example, P2DT5S is a 2 day, 5 second delay).
///
/// See <https://docs.microsoft.com/en-us/windows/win32/taskschd/taskschedulerschema-randomdelay-timetriggertype-element>
///
/// # Example
/// ```
/// use planif::enums::DayOfWeek;
/// use planif::schedule_builder::{ ScheduleBuilder, Weekly };
///
/// let builder: ScheduleBuilder<Weekly> = ScheduleBuilder::new().unwrap()
/// .create_weekly()
/// .trigger("MyTrigger", true).unwrap()
/// .random_delay("P2DT5S").unwrap();
/// ```
pub fn random_delay(self, delay: &str) -> Result<Self, Box<dyn std::error::Error>> {
if let Some(i_trigger) = &self.schedule.trigger {
unsafe {
let i_weekly_trigger: IWeeklyTrigger = i_trigger.cast::<IWeeklyTrigger>()?;
i_weekly_trigger.SetRandomDelay(&BSTR::from(delay))?;
}
Ok(self)
} else {
self.uninitialize();
Err(trigger_uninitialised_error())
}
}
}
fn trigger_uninitialised_error() -> Box<dyn std::error::Error> {
Box::new(InvalidOperationError {
message: "Trigger has not been created yet. Consider calling ScheduleBuilder.Trigger()"
.to_string(),
})
}
/* actions */
/// `Action`s defines the action a scheduled task will take.
/// Currently, only exec actions are support.
#[derive(Debug, Clone)]
pub struct Action {
id: BSTR,
path: BSTR,
working_dir: BSTR,
args: BSTR,
}
impl Action {
/// The work items performed by a task are called actions. A task can have a single action
/// or a maximum of 32 actions. Be aware that when multiple actions are specified, they are executed sequentially.
pub fn new(id: &str, path: &str, working_dir: &str, args: &str) -> Self {
Self {
id: id.into(),
path: path.into(),
working_dir: working_dir.into(),
args: args.into(),
}
}
}