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
//! Functionality that's specific to Drupal. use goose::prelude::*; use log::warn; use regex::Regex; use std::collections::HashMap; use std::env; /// Use a regular expression to get the specific form identified by data-drupal-selector. /// /// See [`get_bigpipe_form`] for a way to extract a form that's served as a BigPipe placeholder. /// /// # Example /// ```rust /// use goose_eggs::drupal::get_form; /// /// // For this example we grab just a subset of a real Drupal form, enough to demonstrate. Normally /// // you'd use the entire html snippet returned from [`validate_and_load_static_assets`]. /// let html = r#" /// <html lang="en" dir="ltr" class="light-mode"> /// <form class="user-login-form" data-drupal-selector="user-login-form" action="/user/login" method="post" id="user-login-form" accept-charset="UTF-8"> /// <div class="js-form-item form-item"> /// <label for="edit-name" class="js-form-required form-required form-item__label">Username</label> /// <input autocorrect="none" autocapitalize="none" spellcheck="false" autofocus="autofocus" data-drupal-selector="edit-name" aria-describedby="edit-name--description" type="text" id="edit-name" name="name" value="" size="60" maxlength="60" class="form-text required form-item__textfield" required="required" aria-required="true" /> /// <div id="edit-name--description" class="form-item__description"> /// Your username. /// </div> /// <input autocomplete="off" data-drupal-selector="form-bhzme2hetuevnwqr5y4pyp8jcau2dfbherwoscwnajm" type="hidden" name="form_build_id" value="form-bHZME2HeTuevNWQR5Y4pyP8jcAu2dfbHERwoscwnajM" class="form-item__textfield" /> /// <input data-drupal-selector="edit-user-login-form" type="hidden" name="form_id" value="user_login_form" class="form-item__textfield" /> /// <div data-drupal-selector="edit-actions" class="form-actions js-form-wrapper form-wrapper" id="edit-actions"><input data-drupal-selector="edit-submit" type="submit" id="edit-submit" name="op" value="Log in" class="button js-form-submit form-submit form-item__textfield" /> /// </div> /// </form> /// </html> /// "#; /// /// let form = get_form(html, "user-login-form"); /// assert!(!form.is_empty()); /// ``` pub fn get_form(html: &str, name: &str) -> String { let re = Regex::new(&format!( // Lazy match to avoid matching multiple forms. r#"<form.*?data-drupal-selector="{}".*?>(.*?)</form>"#, name )) .unwrap(); // Strip carriage returns to simplify regex. let line = html.replace("\n", ""); // Return the entire form, a subset of the received html. match re.captures(&line) { Some(capture) => capture[1].to_string(), None => { warn!("form {} not found", name); "".to_string() } } } /// Use regular expression to get the value of a named form element. /// /// # Example /// ```rust /// use goose_eggs::drupal::{get_form, get_form_value}; /// /// // For this example we grab just a subset of a real Drupal form, enough to demonstrate. Normally /// // you'd use the entire html snippet returned from [`validate_and_load_static_assets`]. /// let html = r#" /// <html lang="en" dir="ltr" class="light-mode"> /// <form class="user-login-form" data-drupal-selector="user-login-form" action=`/user/login` method="post" id="user-login-form" accept-charset="UTF-8"> /// <div class="js-form-item form-item"> /// <label for="edit-name" class="js-form-required form-required form-item__label">Username</label> /// <input autocorrect="none" autocapitalize="none" spellcheck="false" autofocus="autofocus" data-drupal-selector="edit-name" aria-describedby="edit-name--description" type="text" id="edit-name" name="name" value="" size="60" maxlength="60" class="form-text required form-item__textfield" required="required" aria-required="true" /> /// <div id="edit-name--description" class="form-item__description"> /// Your username. /// </div> /// <input autocomplete="off" data-drupal-selector="form-bhzme2hetuevnwqr5y4pyp8jcau2dfbherwoscwnajm" type="hidden" name="form_build_id" value="form-bHZME2HeTuevNWQR5Y4pyP8jcAu2dfbHERwoscwnajM" class="form-item__textfield" /> /// <input data-drupal-selector="edit-form-token" type="hidden" name="form_token" value="5sM6gWNMbHoGq5RGKWQqSis3l5ulFkm4H8OG9pSIBw8" /> /// <input data-drupal-selector="edit-user-login-form" type="hidden" name="form_id" value="user_login_form" class="form-item__textfield" /> /// <div data-drupal-selector="edit-actions" class="form-actions js-form-wrapper form-wrapper" id="edit-actions"><input data-drupal-selector="edit-submit" type="submit" id="edit-submit" name="op" value="Log in" class="button js-form-submit form-submit form-item__textfield" /> /// </div> /// </form> /// </html> /// "#; /// /// let form = get_form(html, "user-login-form"); /// let form_build_id = get_form_value(&form, "form_build_id"); /// assert_eq!(&form_build_id, "form-bHZME2HeTuevNWQR5Y4pyP8jcAu2dfbHERwoscwnajM"); /// ``` pub fn get_form_value(form_html: &str, name: &str) -> String { let re = Regex::new(&format!(r#"name="{}" value=['"](.*?)['"]"#, name)).unwrap(); // Return a specific form value. match re.captures(&form_html) { Some(v) => v[1].to_string(), None => { warn!("form element {} not found", name); "none".to_string() } } } /// Use a regular expression to get a specific form that has been encoded to replace a BigPipe placeholder, /// identified by the data-drupal-selector. /// /// In Drupal 8.1+, BigPipe and Dynamic Page Cache can cause forms (and other content) to be replaced /// with a placeholder where you'd normally expect it, and for an encoded version of the form to then /// appear later in the same page html. This is a performance technique allowing the cacheable portions /// of the page to be quickly visible to the end user. This function is similar to [`get_form`] but uses /// an alternative regex to match an encoded form. /// /// # Example /// ```rust /// use goose_eggs::drupal::get_bigpipe_form; /// /// // For this example we grab just a subset of a real BigPipe placeholder form, enough to demonstrate. /// // Normally you'd use the entire html snippet returned from [`validate_and_load_static_assets`]. /// let html = r#" /// <html lang="en" dir="ltr" class="light-mode"> /// <body> /// /// <script type="application/vnd.drupal-ajax" data-big-pipe-event="start"></script> /// <script type="application/vnd.drupal-ajax" data-big-pipe-replacement-for-placeholder-with-id="callback=shortcut.lazy_builders%3AlazyLinks&&token=N1997Wch59v-LxHku3-dD44wjkSNmhegNzlZ8jS0L5I"> /// [{"command":"insert","method":"replaceWith","selector":"[data-big-pipe-placeholder-id=\u0022callback=shortcut.lazy_builders%3AlazyLinks\u0026\u0026token=N1997Wch59v-LxHku3-dD44wjkSNmhegNzlZ8jS0L5I\u0022]","data":"\u003Ca href=\u0022\/admin\/config\/user-interface\/shortcut\/manage\/default\/customize\u0022 class=\u0022edit-shortcuts\u0022\u003EEdit shortcuts\u003C\/a\u003E","settings":null}] /// </script> <script type="application/vnd.drupal-ajax" data-big-pipe-replacement-for-placeholder-with-id="callback=user.toolbar_link_builder%3ArenderDisplayName&&token=-MH2NzEnTzbzMk0ZGfGgoiw7G3j_-Q1ILWBRVhIOKLI"> /// [{"command":"insert","method":"replaceWith","selector":"[data-big-pipe-placeholder-id=\u0022callback=user.toolbar_link_builder%3ArenderDisplayName\u0026\u0026token=-MH2NzEnTzbzMk0ZGfGgoiw7G3j_-Q1ILWBRVhIOKLI\u0022]","data":"admin","settings":null}] /// </script> <script type="application/vnd.drupal-ajax" data-big-pipe-replacement-for-placeholder-with-id="callback=Drupal%5CFormViewBuilder%3A%3AbuildForm&args%5B0%5D=node&args%5B1%5D=4&args%5B2%5D=field_foo&args%5B3%5D=fo&token=aru2saYxtVupc8Wt4DCKIB0JADknDRk2n1fS6OspTKc"> /// [{"command":"settings","settings":{"ajaxPageState":{"theme":"foo","libraries":"big_pipe\/big_pipe,blazy\/load,comment\/drupal.comment-by-viewer,devel\/devel-toolbar"}:{"edit-ajax-comments-reply-form-node-4-field-foo-0-0":{"url":"\/ajax_comments\/add\/node\/4\/field_foo","dialogType":"ajax","submit":{"_triggering_element_name":"op","_triggering_element_value":"Save"}}},"pluralDelimiter":"\u0003","user":{"uid":"1","permissionsHash":"0f3c5a3dcefdfd2cf26ca0b007b9d2610f88a9cdfa09b08220633755cc13f397"}},"merge":true},{"command":"insert","method":"replaceWith","selector":"[data-big-pipe-placeholder-id=\u0022callback=Drupal%5CRender\u0026args%5B0%5D=node\u0026args%5B1%5D=4\u0026args%5B2%5D=field_foo\u0026args%5B3%5D=reviews\u0026token=aru2saYxtVupc8Wt4DCKIB0JADknDRk2n1fS6OspTKc\u0022]","data":"\u003Cform class=\u0022comment-reviews-form comment-form ajax-comments-reply-form-node-4-field_foo-0-0 ajax-comments-form-add\u0022 id=\u0022ajax-comments-reply-form-node-4-field-foo-0-0\u0022 data-drupal-selector=\u0022comment-form\u0022 action=\u0022\/comment\/reply\/node\/4\/field_foo\u0022 method=\u0022post\u0022 accept-charset=\u0022UTF-8\u0022\u003E\n \u003Cdiv class=\u0022field--type-string field--name-subject field--widget-string-textfield js-form-wrapper form-wrapper\u0022 data-drupal-selector=\u0022edit-subject-wrapper\u0022 id=\u0022edit-subject-wrapper\u0022\u003E \u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Clabel for=\u0022edit-subject-0-value\u0022 class=\u0022js-form-required form-required form-item__label\u0022\u003ETitle\u003C\/label\u003E\n \u003Cinput class=\u0022js-text-full text-full form-text required form-item__textfield\u0022 data-drupal-selector=\u0022edit-subject-0-value\u0022 type=\u0022text\u0022 id=\u0022edit-subject-0-value\u0022 name=\u0022subject[0][value]\u0022 value=\u0022\u0022 size=\u002260\u0022 maxlength=\u002264\u0022 placeholder=\u0022Give your review a title\u0022 required=\u0022required\u0022 aria-required=\u0022true\u0022 \/\u003E\n\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\u003Cinput data-drupal-selector=\u0022edit-form-html-id\u0022 type=\u0022hidden\u0022 name=\u0022form_html_id\u0022 value=\u0022ajax-comments-reply-form-node-4-field-foo-0-0\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput data-drupal-selector=\u0022edit-wrapper-html-id\u0022 type=\u0022hidden\u0022 name=\u0022wrapper_html_id\u0022 value=\u0022node-foo-field-foo\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput autocomplete=\u0022off\u0022 data-drupal-selector=\u0022form-r8d9jop8ekobinr-vflozsd6erwor5-dhqx8s2tozly\u0022 type=\u0022hidden\u0022 name=\u0022form_build_id\u0022 value=\u0022form-R8d9JOp8eKObiNR_vFlOzSD6erWoR5-dHQx8s2toZLY\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput data-drupal-selector=\u0022edit-comment-reviews-form-form-token\u0022 type=\u0022hidden\u0022 name=\u0022form_token\u0022 value=\u00224OCYabXYY116z0_ixUaxzbYlVxEgchgThmF9O3uJqbI\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput data-drupal-selector=\u0022edit-comment-reviews-form\u0022 type=\u0022hidden\u0022 name=\u0022form_id\u0022 value=\u0022comment_reviews_form\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cdiv class=\u0022field--type-fivestar field--name-field-content-rating field--widget-fivestar-stars js-form-wrapper form-wrapper\u0022 data-drupal-selector=\u0022edit-field-content-rating-wrapper\u0022 id=\u0022edit-field-content-rating-wrapper\u0022\u003E \u003Cdiv class=\u0022clearfix fivestar-none-text fivestar-average-stars fivestar-form-item fivestar-basic\u0022\u003E\u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Clabel for=\u0022edit-field-content-rating-0-rating\u0022 class=\u0022form-item__label\u0022\u003ERating\u003C\/label\u003E\n \u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Cdiv class=\u0022form-item__dropdown\u0022\u003E\u003Cselect data-drupal-selector=\u0022edit-field-content-rating-0-rating\u0022 id=\u0022edit-field-content-rating-0-rating--2\u0022 name=\u0022field_content_rating[0][rating]\u0022 class=\u0022form-select form-item__select\u0022\u003E\u003Coption value=\u0022-\u0022\u003ESelect rating\u003C\/option\u003E\u003Coption value=\u002220\u0022\u003EGive it 1\/5\u003C\/option\u003E\u003Coption value=\u002240\u0022\u003EGive it 2\/5\u003C\/option\u003E\u003Coption value=\u002260\u0022\u003EGive it 3\/5\u003C\/option\u003E\u003Coption value=\u002280\u0022\u003EGive it 4\/5\u003C\/option\u003E\u003Coption value=\u0022100\u0022\u003EGive it 5\/5\u003C\/option\u003E\u003C\/select\u003E\u003C\/div\u003E\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\u003C\/div\u003E\n \u003C\/div\u003E\n\u003Cdiv class=\u0022field--type-text-long field--name-comment-body field--widget-text-textarea js-form-wrapper form-wrapper\u0022 data-drupal-selector=\u0022edit-comment-body-wrapper\u0022 id=\u0022edit-comment-body-wrapper\u0022\u003E \u003Cdiv class=\u0022js-text-format-wrapper js-form-item form-item\u0022\u003E\n \u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Clabel for=\u0022edit-comment-body-0-value\u0022 class=\u0022js-form-required form-required form-item__label\u0022\u003EComment\u003C\/label\u003E\n \u003Cdiv\u003E\n \u003Ctextarea class=\u0022js-text-full text-full form-textarea required form-item__textfield form-item__textarea\u0022 data-media-embed-host-entity-langcode=\u0022en\u0022 data-drupal-selector=\u0022edit-comment-body-0-value\u0022 id=\u0022edit-comment-body-0-value\u0022 name=\u0022comment_body[0][value]\u0022 rows=\u00225\u0022 cols=\u002260\u0022 placeholder=\u0022Foo\u0022 required=\u0022required\u0022 aria-required=\u0022true\u0022\u003E\u003C\/textarea\u003E\n\u003C\/div\u003E\n\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\u003Cdiv data-drupal-selector=\u0022edit-actions\u0022 class=\u0022form-actions js-form-wrapper form-wrapper\u0022 id=\u0022edit-actions\u0022\u003E\u003Cinput data-drupal-selector=\u0022edit-ajax-comments-reply-form-node-4-field-foo-0-0\u0022 type=\u0022submit\u0022 id=\u0022edit-ajax-comments-reply-form-node-4-field-foo-0-0\u0022 name=\u0022op\u0022 value=\u0022Submit Review\u0022 class=\u0022button button--primary js-form-submit form-submit form-item__textfield\u0022 \/\u003E\n\u003C\/div\u003E\n\n\u003C\/form\u003E\n","settings":null}] /// </script> <script type="application/vnd.drupal-ajax" data-big-pipe-replacement-for-placeholder-with-id="callback=Drupal%5CFormViewBuilder%3A%3BbuildForm&args%5B0%5D=node&args%5B1%5D=4&args%5B2%5D=field_bar&args%5B3%5D=fo&token=aru2saYxtVupc8Wt4DCKIB0JADknDRk2n1fS6OspTKc"> /// [{"command":"settings","settings":{"ajaxPageState":{"theme":"bar","libraries":"big_pipe\/big_pipe,blazy\/load,comment\/drupal.comment-by-viewer,devel\/devel-toolbar"}:{"edit-ajax-comments-reply-form-node-4-field-bar-0-0":{"url":"\/ajax_comments\/add\/node\/4\/field_bar","dialogType":"ajax","submit":{"_triggering_element_name":"op","_triggering_element_value":"Save"}}},"pluralDelimiter":"\u0003","user":{"uid":"1","permissionsHash":"0f3c5a3dcefdfd2cf26ca0b007b9d2610f88a9cdfa09b08220633755cc13f397"}},"merge":true},{"command":"insert","method":"replaceWith","selector":"[data-big-pipe-placeholder-id=\u0022callback=Drupal%5CRender\u0026args%5B0%5D=node\u0026args%5B1%5D=4\u0026args%5B2%5D=field_bar\u0026args%5B3%5D=reviews\u0026token=aru2saYxtVupc8Wt4DCKIB0JADknDRk2n1fS6OspTKc\u0022]","data":"\u003Cform class=\u0022comment-reviews-form comment-form ajax-comments-reply-form-node-4-field_bar-0-0 ajax-comments-form-add\u0022 id=\u0022ajax-comments-reply-form-node-4-field-bar-0-0\u0022 data-drupal-selector=\u0022alternative-comment-form\u0022 action=\u0022\/comment\/reply\/node\/4\/field_bar\u0022 method=\u0022post\u0022 accept-charset=\u0022UTF-8\u0022\u003E\n \u003Cdiv class=\u0022field--type-string field--name-subject field--widget-string-textfield js-form-wrapper form-wrapper\u0022 data-drupal-selector=\u0022edit-subject-wrapper\u0022 id=\u0022edit-subject-wrapper\u0022\u003E \u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Clabel for=\u0022edit-subject-0-value\u0022 class=\u0022js-form-required form-required form-item__label\u0022\u003ETitle\u003C\/label\u003E\n \u003Cinput class=\u0022js-text-full text-full form-text required form-item__textfield\u0022 data-drupal-selector=\u0022edit-subject-0-value\u0022 type=\u0022text\u0022 id=\u0022edit-subject-0-value\u0022 name=\u0022subject[0][value]\u0022 value=\u0022\u0022 size=\u002260\u0022 maxlength=\u002264\u0022 placeholder=\u0022Give your review a title\u0022 required=\u0022required\u0022 aria-required=\u0022true\u0022 \/\u003E\n\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\u003Cinput data-drupal-selector=\u0022edit-form-html-id\u0022 type=\u0022hidden\u0022 name=\u0022form_html_id\u0022 value=\u0022ajax-comments-reply-form-node-4-field-bar-0-0\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput data-drupal-selector=\u0022edit-wrapper-html-id\u0022 type=\u0022hidden\u0022 name=\u0022wrapper_html_id\u0022 value=\u0022node-bar-field-bar\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput autocomplete=\u0022off\u0022 data-drupal-selector=\u0022form-r8d9jop8ekobinr-vflozsd6erwor5-dhqx8s2tozly\u0022 type=\u0022hidden\u0022 name=\u0022form_build_id\u0022 value=\u0022form-S7a8OJ2ebKObiNR_zRm3bW5EerWoR5-dHQx8s2toABC\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput data-drupal-selector=\u0022edit-comment-reviews-form-form-token\u0022 type=\u0022hidden\u0022 name=\u0022form_token\u0022 value=\u002281BDfbXZZ234a1_ixUaxzbYlVxTgchoInnA321jUrhU\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput data-drupal-selector=\u0022edit-comment-reviews-form\u0022 type=\u0022hidden\u0022 name=\u0022form_id\u0022 value=\u0022comment_reviews_form\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cdiv class=\u0022field--type-fivestar field--name-field-content-rating field--widget-fivestar-stars js-form-wrapper form-wrapper\u0022 data-drupal-selector=\u0022edit-field-content-rating-wrapper\u0022 id=\u0022edit-field-content-rating-wrapper\u0022\u003E \u003Cdiv class=\u0022clearfix fivestar-none-text fivestar-average-stars fivestar-form-item fivestar-basic\u0022\u003E\u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Clabel for=\u0022edit-field-content-rating-0-rating\u0022 class=\u0022form-item__label\u0022\u003ERating\u003C\/label\u003E\n \u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Cdiv class=\u0022form-item__dropdown\u0022\u003E\u003Cselect data-drupal-selector=\u0022edit-field-content-rating-0-rating\u0022 id=\u0022edit-field-content-rating-0-rating--2\u0022 name=\u0022field_content_rating[0][rating]\u0022 class=\u0022form-select form-item__select\u0022\u003E\u003Coption value=\u0022-\u0022\u003ESelect rating\u003C\/option\u003E\u003Coption value=\u002220\u0022\u003EGive it 1\/5\u003C\/option\u003E\u003Coption value=\u002240\u0022\u003EGive it 2\/5\u003C\/option\u003E\u003Coption value=\u002260\u0022\u003EGive it 3\/5\u003C\/option\u003E\u003Coption value=\u002280\u0022\u003EGive it 4\/5\u003C\/option\u003E\u003Coption value=\u0022100\u0022\u003EGive it 5\/5\u003C\/option\u003E\u003C\/select\u003E\u003C\/div\u003E\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\u003C\/div\u003E\n \u003C\/div\u003E\n\u003Cdiv class=\u0022field--type-text-long field--name-comment-body field--widget-text-textarea js-form-wrapper form-wrapper\u0022 data-drupal-selector=\u0022edit-comment-body-wrapper\u0022 id=\u0022edit-comment-body-wrapper\u0022\u003E \u003Cdiv class=\u0022js-text-format-wrapper js-form-item form-item\u0022\u003E\n \u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Clabel for=\u0022edit-comment-body-0-value\u0022 class=\u0022js-form-required form-required form-item__label\u0022\u003EComment\u003C\/label\u003E\n \u003Cdiv\u003E\n \u003Ctextarea class=\u0022js-text-full text-full form-textarea required form-item__textfield form-item__textarea\u0022 data-media-embed-host-entity-langcode=\u0022en\u0022 data-drupal-selector=\u0022edit-comment-body-0-value\u0022 id=\u0022edit-comment-body-0-value\u0022 name=\u0022comment_body[0][value]\u0022 rows=\u00225\u0022 cols=\u002260\u0022 placeholder=\u0022Bar\u0022 required=\u0022required\u0022 aria-required=\u0022true\u0022\u003E\u003C\/textarea\u003E\n\u003C\/div\u003E\n\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\u003Cdiv data-drupal-selector=\u0022edit-actions\u0022 class=\u0022form-actions js-form-wrapper form-wrapper\u0022 id=\u0022edit-actions\u0022\u003E\u003Cinput data-drupal-selector=\u0022edit-ajax-comments-reply-form-node-4-field-bar-0-0\u0022 type=\u0022submit\u0022 id=\u0022edit-ajax-comments-reply-form-node-4-field-bar-0-0\u0022 name=\u0022op\u0022 value=\u0022Submit Review\u0022 class=\u0022button button--primary js-form-submit form-submit form-item__textfield\u0022 \/\u003E\n\u003C\/div\u003E\n\n\u003C\/form\u003E\n","settings":null}] /// </script> /// <script type="application/vnd.drupal-ajax" data-big-pipe-event="stop"></script> /// </body> /// </html> /// "#; /// /// let form = get_bigpipe_form(html, "comment-form"); /// // We matched at least one form. /// assert!(!form.is_empty()); /// // We matched only one form. /// assert_eq!(form.lines().count(), 1); /// ``` pub fn get_bigpipe_form(html: &str, name: &str) -> String { let re = Regex::new( // Lazy match to avoid matching multiple forms. &format!( "{}.*?data-drupal-selector=.*?{}(.*?){}", regex::escape(r#"[{"#), regex::escape(name), regex::escape(r#"}]"#) ), ) .unwrap(); // Strip carriage returns to simplify regex. let line = html.replace("\n", ""); // Return the entire form, a subset of the received html. match re.captures(&line) { Some(capture) => capture[1].to_string(), None => { warn!("bigpipe form {} not found", name); "".to_string() } } } /// Load a form value from an encoded form. /// /// Gets form values from forms that are returned by ajax callbacks or embedded by BigPipe. /// /// # Example /// ```rust /// use goose_eggs::drupal::get_encoded_form_value; /// /// let form = r#"<script type="application/vnd.drupal-ajax" data-big-pipe-replacement-for-placeholder-with-id="callback=Drupal%5CFormViewBuilder%3A%3AbuildForm&args%5B0%5D=node&args%5B1%5D=4&args%5B2%5D=field_foo&args%5B3%5D=fo&token=aru2saYxtVupc8Wt4DCKIB0JADknDRk2n1fS6OspTKc"> /// [{"command":"settings","settings":{"ajaxPageState":{"theme":"foo","libraries":"big_pipe\/big_pipe,blazy\/load,comment\/drupal.comment-by-viewer,devel\/devel-toolbar"}:{"edit-ajax-comments-reply-form-node-4-field-foo-0-0":{"url":"\/ajax_comments\/add\/node\/4\/field_foo","dialogType":"ajax","submit":{"_triggering_element_name":"op","_triggering_element_value":"Save"}}},"pluralDelimiter":"\u0003","user":{"uid":"1","permissionsHash":"0f3c5a3dcefdfd2cf26ca0b007b9d2610f88a9cdfa09b08220633755cc13f397"}},"merge":true},{"command":"insert","method":"replaceWith","selector":"[data-big-pipe-placeholder-id=\u0022callback=Drupal%5CRender\u0026args%5B0%5D=node\u0026args%5B1%5D=4\u0026args%5B2%5D=field_foo\u0026args%5B3%5D=reviews\u0026token=aru2saYxtVupc8Wt4DCKIB0JADknDRk2n1fS6OspTKc\u0022]","data":"\u003Cform class=\u0022comment-reviews-form comment-form ajax-comments-reply-form-node-4-field_foo-0-0 ajax-comments-form-add\u0022 id=\u0022ajax-comments-reply-form-node-4-field-foo-0-0\u0022 data-drupal-selector=\u0022comment-form\u0022 action=\u0022\/comment\/reply\/node\/4\/field_foo\u0022 method=\u0022post\u0022 accept-charset=\u0022UTF-8\u0022\u003E\n \u003Cdiv class=\u0022field--type-string field--name-subject field--widget-string-textfield js-form-wrapper form-wrapper\u0022 data-drupal-selector=\u0022edit-subject-wrapper\u0022 id=\u0022edit-subject-wrapper\u0022\u003E \u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Clabel for=\u0022edit-subject-0-value\u0022 class=\u0022js-form-required form-required form-item__label\u0022\u003ETitle\u003C\/label\u003E\n \u003Cinput class=\u0022js-text-full text-full form-text required form-item__textfield\u0022 data-drupal-selector=\u0022edit-subject-0-value\u0022 type=\u0022text\u0022 id=\u0022edit-subject-0-value\u0022 name=\u0022subject[0][value]\u0022 value=\u0022\u0022 size=\u002260\u0022 maxlength=\u002264\u0022 placeholder=\u0022Give your review a title\u0022 required=\u0022required\u0022 aria-required=\u0022true\u0022 \/\u003E\n\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\u003Cinput data-drupal-selector=\u0022edit-form-html-id\u0022 type=\u0022hidden\u0022 name=\u0022form_html_id\u0022 value=\u0022ajax-comments-reply-form-node-4-field-foo-0-0\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput data-drupal-selector=\u0022edit-wrapper-html-id\u0022 type=\u0022hidden\u0022 name=\u0022wrapper_html_id\u0022 value=\u0022node-foo-field-foo\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput autocomplete=\u0022off\u0022 data-drupal-selector=\u0022form-r8d9jop8ekobinr-vflozsd6erwor5-dhqx8s2tozly\u0022 type=\u0022hidden\u0022 name=\u0022form_build_id\u0022 value=\u0022form-R8d9JOp8eKObiNR_vFlOzSD6erWoR5-dHQx8s2toZLY\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput data-drupal-selector=\u0022edit-comment-reviews-form-form-token\u0022 type=\u0022hidden\u0022 name=\u0022form_token\u0022 value=\u00224OCYabXYY116z0_ixUaxzbYlVxEgchgThmF9O3uJqbI\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cinput data-drupal-selector=\u0022edit-comment-reviews-form\u0022 type=\u0022hidden\u0022 name=\u0022form_id\u0022 value=\u0022comment_reviews_form\u0022 class=\u0022form-item__textfield\u0022 \/\u003E\n\u003Cdiv class=\u0022field--type-fivestar field--name-field-content-rating field--widget-fivestar-stars js-form-wrapper form-wrapper\u0022 data-drupal-selector=\u0022edit-field-content-rating-wrapper\u0022 id=\u0022edit-field-content-rating-wrapper\u0022\u003E \u003Cdiv class=\u0022clearfix fivestar-none-text fivestar-average-stars fivestar-form-item fivestar-basic\u0022\u003E\u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Clabel for=\u0022edit-field-content-rating-0-rating\u0022 class=\u0022form-item__label\u0022\u003ERating\u003C\/label\u003E\n \u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Cdiv class=\u0022form-item__dropdown\u0022\u003E\u003Cselect data-drupal-selector=\u0022edit-field-content-rating-0-rating\u0022 id=\u0022edit-field-content-rating-0-rating--2\u0022 name=\u0022field_content_rating[0][rating]\u0022 class=\u0022form-select form-item__select\u0022\u003E\u003Coption value=\u0022-\u0022\u003ESelect rating\u003C\/option\u003E\u003Coption value=\u002220\u0022\u003EGive it 1\/5\u003C\/option\u003E\u003Coption value=\u002240\u0022\u003EGive it 2\/5\u003C\/option\u003E\u003Coption value=\u002260\u0022\u003EGive it 3\/5\u003C\/option\u003E\u003Coption value=\u002280\u0022\u003EGive it 4\/5\u003C\/option\u003E\u003Coption value=\u0022100\u0022\u003EGive it 5\/5\u003C\/option\u003E\u003C\/select\u003E\u003C\/div\u003E\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\u003C\/div\u003E\n \u003C\/div\u003E\n\u003Cdiv class=\u0022field--type-text-long field--name-comment-body field--widget-text-textarea js-form-wrapper form-wrapper\u0022 data-drupal-selector=\u0022edit-comment-body-wrapper\u0022 id=\u0022edit-comment-body-wrapper\u0022\u003E \u003Cdiv class=\u0022js-text-format-wrapper js-form-item form-item\u0022\u003E\n \u003Cdiv class=\u0022js-form-item form-item\u0022\u003E\n \u003Clabel for=\u0022edit-comment-body-0-value\u0022 class=\u0022js-form-required form-required form-item__label\u0022\u003EComment\u003C\/label\u003E\n \u003Cdiv\u003E\n \u003Ctextarea class=\u0022js-text-full text-full form-textarea required form-item__textfield form-item__textarea\u0022 data-media-embed-host-entity-langcode=\u0022en\u0022 data-drupal-selector=\u0022edit-comment-body-0-value\u0022 id=\u0022edit-comment-body-0-value\u0022 name=\u0022comment_body[0][value]\u0022 rows=\u00225\u0022 cols=\u002260\u0022 placeholder=\u0022Foo\u0022 required=\u0022required\u0022 aria-required=\u0022true\u0022\u003E\u003C\/textarea\u003E\n\u003C\/div\u003E\n\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\n \u003C\/div\u003E\n\u003Cdiv data-drupal-selector=\u0022edit-actions\u0022 class=\u0022form-actions js-form-wrapper form-wrapper\u0022 id=\u0022edit-actions\u0022\u003E\u003Cinput data-drupal-selector=\u0022edit-ajax-comments-reply-form-node-4-field-foo-0-0\u0022 type=\u0022submit\u0022 id=\u0022edit-ajax-comments-reply-form-node-4-field-foo-0-0\u0022 name=\u0022op\u0022 value=\u0022Submit Review\u0022 class=\u0022button button--primary js-form-submit form-submit form-item__textfield\u0022 \/\u003E\n\u003C\/div\u003E\n\n\u003C\/form\u003E\n","settings":null}] /// </script>"#; /// /// let form_build_id = get_encoded_form_value(form, "form_build_id"); /// assert_eq!(form_build_id, "form-R8d9JOp8eKObiNR_vFlOzSD6erWoR5-dHQx8s2toZLY"); /// ``` pub fn get_encoded_form_value(form_html: &str, name: &str) -> String { // Decode quotes, which is enough for the normal get_form_value() regex to work. let decoded_form = form_html.replace("\\u0022", r#"""#); get_form_value(&decoded_form, name) } /// Extract an updated build_id from a form. /// /// After certain form actions, such as uploading a file, Drupal can change the `build_id`. Requires the original /// `build_id`. /// /// ```rust /// use goose_eggs::drupal::get_updated_build_id; /// /// let build_id = "form-jsirb7DiRiBC09VrCJRfj-D1z6kjzX-sMqUgHmM_bCs"; /// /// let form_snippet = r#"{"command":"update_build_id","old":"form-jsirb7DiRiBC09VrCJRfj-D1z6kjzX-sMqUgHmM_bCs","new":"form-0VJ1MsfQR17RKlwarp_Rh_wMzbmjMlJc1SX_oPc0Bkc"}"#; /// /// let updated_build_id = get_updated_build_id(form_snippet, build_id); /// assert_eq!(updated_build_id, "form-0VJ1MsfQR17RKlwarp_Rh_wMzbmjMlJc1SX_oPc0Bkc"); /// ``` pub fn get_updated_build_id(form_html: &str, old_build_id: &str) -> String { let re = Regex::new(&format!( "{}{}{}", r#"\{"command":"update_build_id","old":""#, old_build_id, r#"","new":"(.*?)"\}"# )) .unwrap(); // Return a specific form value. match re.captures(&form_html) { Some(v) => v[1].to_string(), None => { warn!("update_build_id not found"); "none".to_string() } } } /// Loop through an array of named form elements returning their values in a HashMap. /// /// # Example /// ```rust /// use goose_eggs::drupal::{get_form, get_form_values}; /// /// // For this example we grab just a subset of a real Drupal form, enough to demonstrate. Normally /// // you'd use the entire html snippet returned from [`validate_and_load_static_assets`]. /// let html = r#" /// <html lang="en" dir="ltr" class="light-mode"> /// <form class="user-login-form" data-drupal-selector="user-login-form" action=`/user/login` method="post" id="user-login-form" accept-charset="UTF-8"> /// <div class="js-form-item form-item"> /// <label for="edit-name" class="js-form-required form-required form-item__label">Username</label> /// <input autocorrect="none" autocapitalize="none" spellcheck="false" autofocus="autofocus" data-drupal-selector="edit-name" aria-describedby="edit-name--description" type="text" id="edit-name" name="name" value="" size="60" maxlength="60" class="form-text required form-item__textfield" required="required" aria-required="true" /> /// <div id="edit-name--description" class="form-item__description"> /// Your username. /// </div> /// <input autocomplete="off" data-drupal-selector="form-bhzme2hetuevnwqr5y4pyp8jcau2dfbherwoscwnajm" type="hidden" name="form_build_id" value="form-bHZME2HeTuevNWQR5Y4pyP8jcAu2dfbHERwoscwnajM" class="form-item__textfield" /> /// <input data-drupal-selector="edit-form-token" type="hidden" name="form_token" value="5sM6gWNMbHoGq5RGKWQqSis3l5ulFkm4H8OG9pSIBw8" /> /// <input data-drupal-selector="edit-user-login-form" type="hidden" name="form_id" value="user_login_form" class="form-item__textfield" /> /// <div data-drupal-selector="edit-actions" class="form-actions js-form-wrapper form-wrapper" id="edit-actions"><input data-drupal-selector="edit-submit" type="submit" id="edit-submit" name="op" value="Log in" class="button js-form-submit form-submit form-item__textfield" /> /// </div> /// </form> /// </html> /// "#; /// /// let form = get_form(html, "user-login-form"); /// // Specify the three form elements we're looking for. /// let form_values = get_form_values(&form, &["form_token", "form_build_id", "form_id"]); /// // Confirm that all three form values were correctly identified. /// assert_eq!(form_values.get("form_token").unwrap().as_str(), "5sM6gWNMbHoGq5RGKWQqSis3l5ulFkm4H8OG9pSIBw8"); /// assert_eq!(form_values.get("form_build_id").unwrap().as_str(), "form-bHZME2HeTuevNWQR5Y4pyP8jcAu2dfbHERwoscwnajM"); /// assert_eq!(form_values.get("form_id").unwrap().as_str(), "user_login_form"); /// ``` pub fn get_form_values<'a>(form: &str, elements: &'a [&str]) -> HashMap<&'a str, String> { let mut form_elements = HashMap::new(); // Extract the form elements needed to submit a form. for &element in elements { let value = get_form_value(&form, element); form_elements.insert(element, value); } form_elements } /// Set one or more defaults when logging in through the standard drupal user-login-form. /// /// This object is passed to [`log_in`] to set a custom default username and/or password /// and/or log in url and/or the required title after login. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// fn examples() { /// // Manually build a Login structure with custom username and password. /// let _login = Login::new(Some("foo"), Some("bar"), None, None); /// /// // Call `Login::username_password` to build the same. /// let mut login = Login::username_password("foo", "bar"); /// /// // Now also change the url and expected title. /// login.unwrap().update_url_title("/custom/user/login", "Custom title"); /// } pub struct Login<'a> { // Optionally set a default username. username: Option<&'a str>, // Optionally set a default password. password: Option<&'a str>, // Optionally set a custom default path (otherwise defaults to `/user/login`). url: Option<&'a str>, // Optionally set a custom title to validate. title: Option<&'a str>, } impl<'a> Login<'a> { /// Create a new Login object, specifying `username`, `password`, `url`, and expected /// `title`. /// /// It's generally preferred to use a helper such as [`Login::username_password`] or /// [`Login::url_title`] instead of invoking this function directly. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let _login = Login::new( /// // Set a default username of "foo". /// Some("foo"), /// // Set a default password of "bar". /// Some("bar"), /// // Set a custom log-in path of "/custom/login/path". /// Some("/custom/login/path"), /// // Set a custom title to validate after log-in. /// Some("Custom Title"), /// ); /// ``` pub fn new( username: Option<&'a str>, password: Option<&'a str>, url: Option<&'a str>, title: Option<&'a str>, ) -> Option<Login<'a>> { Some(Login { username, password, url, title, }) } /// Create a Login object setting a custom default username. /// /// The password will remain the default of `password`. The login url will remain the /// default of `/user/login`. After login the title will be validated to confirm it /// include's the username. The username and password defaults can still be overridden /// by the `GOOSE_USER` and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let _login = Login::username("foo"); /// ``` pub fn username(username: &'a str) -> Option<Login<'a>> { Login::new(Some(username), None, None, None) } /// Create a Login object setting a custom default password. /// /// The username will remain the default of `username`. The login url will remain the /// default of `/user/login`. After login the title will be validated to confirm it /// include's the username. The username and password defaults can still be overridden /// by the `GOOSE_USER` and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let _login = Login::password("bar"); /// ``` pub fn password(password: &'a str) -> Option<Login<'a>> { Login::new(None, Some(password), None, None) } /// Create a Login object setting a custom default username and password. /// /// The login url will remain the default of `/user/login`. After login the title will /// be validated to confirm it include's the username. The username and password defaults /// can still be overridden by the `GOOSE_USER` and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let _login = Login::username_password("foo", "bar"); /// ``` pub fn username_password(username: &'a str, password: &'a str) -> Option<Login<'a>> { Login::new(Some(username), Some(password), None, None) } /// Create a Login object with a custom default login url. /// /// The username will remain the default of `username`. The password will remain the /// default of `password`. After login the title will be validated to confirm it /// include's the username. The username and password defaults can still be /// overridden by the `GOOSE_USER` and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let _login = Login::password("bar"); /// ``` /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let _login = Login::url("/custom/user/login"); /// ``` pub fn url(url: &'a str) -> Option<Login<'a>> { Login::new(None, None, Some(url), None) } /// Create a Login object with a custom expected title after login. /// /// The username will remain the default of `username`. The password will remain the /// default of `password`. The login url will remain the default of `/user/login`. /// The username and password defaults can still be overridden by the `GOOSE_USER` and /// `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let _login = Login::password("bar"); /// ``` /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let _login = Login::title("Custom title"); /// ``` pub fn title(title: &'a str) -> Option<Login<'a>> { Login::new(None, None, None, Some(title)) } /// Create a Login object with custom default url and a custom expected title after /// login. /// /// The username will remain the default of `username`. The password will remain the /// default of `password`. The username and password defaults can still be overridden /// by the `GOOSE_USER` and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let _login = Login::password("bar"); /// ``` /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let _login = Login::url_title("/custom/login/path", "Custom title"); /// ``` pub fn url_title(url: &'a str, title: &'a str) -> Option<Login<'a>> { Login::new(None, None, Some(url), Some(title)) } /// Update a Login object, changing the default username. /// /// The password, url and title fields will not be changed. /// /// The username and password defaults can still be overridden by the `GOOSE_USER` /// and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let login = /// Login::password("bar") /// .unwrap() /// .update_username("foo"); /// ``` pub fn update_username(mut self, username: &'a str) -> Option<Self> { self.username = Some(username); Some(self) } /// Update a Login object, changing the default password. /// /// The username, url and title fields will not be changed. /// /// The username and password defaults can still be overridden by the `GOOSE_USER` /// and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let login = /// Login::username("foo") /// .unwrap() /// .update_password("bar"); /// ``` pub fn update_password(mut self, password: &'a str) -> Option<Self> { self.password = Some(password); Some(self) } /// Update a Login object, changing the default username and password. /// /// The url and title fields will not be changed. /// /// The username and password defaults can still be overridden by the `GOOSE_USER` /// and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let login = /// Login::username_password("foo", "bar") /// .unwrap() /// .update_username_password("changed-username", "changed-password"); /// ``` pub fn update_username_password( mut self, username: &'a str, password: &'a str, ) -> Option<Self> { self.username = Some(username); self.password = Some(password); Some(self) } /// Update a Login object, changing the default login url. /// /// The username, password and title fields will not be changed. /// /// The username and password defaults can still be overridden by the `GOOSE_USER` /// and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let login = /// Login::username("foo") /// .unwrap() /// .update_url("/custom/user/login"); /// ``` pub fn update_url(mut self, url: &'a str) -> Option<Self> { self.url = Some(url); Some(self) } /// Update a Login object, changing the expected title after login. /// /// The username and password fields will not be changed. /// /// The username and password defaults can still be overridden by the `GOOSE_USER` /// and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let login = /// Login::username("foo") /// .unwrap() /// .update_title("Custom Title"); /// ``` pub fn update_title(mut self, title: &'a str) -> Option<Self> { self.title = Some(title); Some(self) } /// Update a Login object, changing the default login url and the expected title /// after login. /// /// The username and password fields will not be changed. /// /// The username and password defaults can still be overridden by the `GOOSE_USER` /// and `GOOSE_PASS` environment variables. /// /// # Example /// ```rust /// use goose_eggs::drupal::Login; /// /// let login = /// Login::username_password("foo", "password") /// .unwrap() /// .update_url_title("/custom/user/login", "Custom Title"); /// ``` pub fn update_url_title(mut self, url: &'a str, title: &'a str) -> Option<Self> { self.url = Some(url); self.title = Some(title); Some(self) } } /// Log into a Drupal website. /// /// The reference to a GooseUser object is from a Goose task function. The optional /// pointer to a [`Login`] object can be created to override the username, password, /// login url, or expected page title after log in. /// /// If no default username is set in the [`Login`] object, the function will default to /// a username of `username` which can be overridden by the `GOOSE_USER` environment variable. /// If no default password is set in the [`Login`] object, the function will default to /// a password of `password` which can be overridden by the `GOOSE_PASS` environment variable. /// If no default url is set in the [`Login`] object, the function will default to a url /// of `/user/login`. If no default title is set in the [`Login`] object, the function /// will verify that the title includes the username after login. /// /// # Example /// ```rust /// use goose::prelude::*; /// use goose_eggs::drupal::{log_in, Login}; /// /// task!(login).set_on_start(); /// /// async fn login(user: &GooseUser) -> GooseTaskResult { /// // By default log in with `foo`:`bar`. /// let _html = log_in(&user, Login::username_password("foo", "bar").as_ref()).await?; /// /// Ok(()) /// } /// /// ``` pub async fn log_in(user: &GooseUser, login: Option<&Login<'_>>) -> Result<String, GooseTaskError> { // Use the `GOOSE_USER` environment variable if it's set, otherwise use the custom username // passed in when calling this function, otherwise use `username`. let default_password = "username"; let username = env::var("GOOSE_USER").unwrap_or_else(|_| match login { Some(l) => l.username.unwrap_or(default_password).to_string(), None => default_password.to_string(), }); // Use the `GOOSE_PASS` environment variable if it's set, otherwise use the custom password // passed in when calling this function, otherwise use `password`. let default_password = "password"; let password = env::var("GOOSE_PASS").unwrap_or_else(|_| match login { Some(l) => l.password.unwrap_or(default_password).to_string(), None => default_password.to_string(), }); // Load the log in page. let default_login = "/user/login"; let login_url = match login { Some(l) => l.url.unwrap_or(default_login), None => default_login, }; let goose = user.get(login_url).await?; // Save the request to extract the form_build_id. let mut login_request = goose.request.clone(); let login_page = crate::validate_and_load_static_assets( user, goose, &crate::Validate::text(r#"<form class="user-login-form""#), ) .await?; // A web page can have multiple forms, so first get the correct form. let login_form = get_form(&login_page, "user-login-form"); if login_form.is_empty() { user.set_failure( &format!("{}: no user-login-form on page", login_url), &mut login_request, None, Some(&login_page), )?; // Return an empty string as log-in failed. Enable the debug log to // determine why. return Ok("".to_string()); } // Now extract the form_build_id in order to POST to the log in form. let form_build_id = get_form_value(&login_form, "form_build_id"); if form_build_id.is_empty() { user.set_failure( &format!("{}: no form_build_id on page", login_url), &mut login_request, None, Some(&login_form), )?; // Return an empty string as log-in failed. Enable the debug log to // determine why. return Ok("".to_string()); } // Build log in form with username and password from environment. let params = [ ("name", &username), ("pass", &password), ("form_build_id", &form_build_id), ("form_id", &"user_login_form".to_string()), ("op", &"Log+in".to_string()), ]; let request_builder = user.goose_post("/user/login").await?; let mut logged_in_user = user.goose_send(request_builder.form(¶ms), None).await?; // A successful log in is redirected. if !logged_in_user.request.redirected { // There was an error, get the headers and html if any to aid in debugging. let headers; let html = match logged_in_user.response { Ok(r) => { headers = Some(r.headers().clone()); r.text().await.unwrap_or_else(|e| e.to_string()) } Err(e) => { headers = None; e.to_string() } }; user.set_failure( &format!( "{}: login failed (check `GOOSE_USER` and `GOOSE_PASS`)", logged_in_user.request.final_url ), &mut logged_in_user.request, headers.as_ref(), Some(&html), )?; // Return the html that was loaded, even though log-in failed. Enable // the debug_log to determine why log-in failed. return Ok(html); } // By default expect the username to be in the title. let default_title = username; let title = match login { // Allow a different expected title than the Drupal default. Some(l) => l.title.unwrap_or(&default_title), None => &default_title, }; // Check the title to verify that the user is actually logged in. let logged_in_page = crate::validate_and_load_static_assets( user, logged_in_user, &crate::Validate::title(title), ) .await?; Ok(logged_in_page) }