/* zip_progress.c -- progress reporting Copyright (C) 2017-2020 Dieter Baron and Thomas Klausner This file is part of libzip, a library to manipulate ZIP archives. The authors can be contacted at Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The names of the authors may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include #define _ZIP_COMPILING_DEPRECATED #include "zipint.h" struct zip_progress { zip_t *za; zip_progress_callback callback_progress; void (*ud_progress_free)(void *); void *ud_progress; zip_cancel_callback callback_cancel; void (*ud_cancel_free)(void *); void *ud_cancel; double precision; /* state */ double last_update; /* last value callback function was called with */ double start; /* start of sub-progress section */ double end; /* end of sub-progress section */ }; static void _zip_progress_free_cancel_callback(zip_progress_t *progress); static void _zip_progress_free_progress_callback(zip_progress_t *progress); static zip_progress_t *_zip_progress_new(zip_t *za); static void _zip_progress_set_cancel_callback(zip_progress_t *progress, zip_cancel_callback callback, void (*ud_free)(void *), void *ud); static void _zip_progress_set_progress_callback(zip_progress_t *progress, double precision, zip_progress_callback callback, void (*ud_free)(void *), void *ud); void _zip_progress_end(zip_progress_t *progress) { _zip_progress_update(progress, 1.0); } void _zip_progress_free(zip_progress_t *progress) { if (progress == NULL) { return; } _zip_progress_free_progress_callback(progress); _zip_progress_free_cancel_callback(progress); free(progress); } static zip_progress_t * _zip_progress_new(zip_t *za) { zip_progress_t *progress = (zip_progress_t *)malloc(sizeof(*progress)); if (progress == NULL) { zip_error_set(&za->error, ZIP_ER_MEMORY, 0); return NULL; } progress->za = za; progress->callback_progress = NULL; progress->ud_progress_free = NULL; progress->ud_progress = NULL; progress->precision = 0.0; progress->callback_cancel = NULL; progress->ud_cancel_free = NULL; progress->ud_cancel = NULL; return progress; } static void _zip_progress_free_progress_callback(zip_progress_t *progress) { if (progress->ud_progress_free) { progress->ud_progress_free(progress->ud_progress); } progress->callback_progress = NULL; progress->ud_progress = NULL; progress->ud_progress_free = NULL; } static void _zip_progress_free_cancel_callback(zip_progress_t *progress) { if (progress->ud_cancel_free) { progress->ud_cancel_free(progress->ud_cancel); } progress->callback_cancel = NULL; progress->ud_cancel = NULL; progress->ud_cancel_free = NULL; } static void _zip_progress_set_progress_callback(zip_progress_t *progress, double precision, zip_progress_callback callback, void (*ud_free)(void *), void *ud) { _zip_progress_free_progress_callback(progress); progress->callback_progress = callback; progress->ud_progress_free = ud_free; progress->ud_progress = ud; progress->precision = precision; } void _zip_progress_set_cancel_callback(zip_progress_t *progress, zip_cancel_callback callback, void (*ud_free)(void *), void *ud) { _zip_progress_free_cancel_callback(progress); progress->callback_cancel = callback; progress->ud_cancel_free = ud_free; progress->ud_cancel = ud; } int _zip_progress_start(zip_progress_t *progress) { if (progress == NULL) { return 0; } if (progress->callback_progress != NULL) { progress->last_update = 0.0; progress->callback_progress(progress->za, 0.0, progress->ud_progress); } if (progress->callback_cancel != NULL) { if (progress->callback_cancel(progress->za, progress->ud_cancel)) { return -1; } } return 0; } int _zip_progress_subrange(zip_progress_t *progress, double start, double end) { if (progress == NULL) { return 0; } progress->start = start; progress->end = end; return _zip_progress_update(progress, 0.0); } int _zip_progress_update(zip_progress_t *progress, double sub_current) { double current; if (progress == NULL) { return 0; } if (progress->callback_progress != NULL) { current = ZIP_MIN(ZIP_MAX(sub_current, 0.0), 1.0) * (progress->end - progress->start) + progress->start; if (current - progress->last_update > progress->precision) { progress->callback_progress(progress->za, current, progress->ud_progress); progress->last_update = current; } } if (progress->callback_cancel != NULL) { if (progress->callback_cancel(progress->za, progress->ud_cancel)) { return -1; } } return 0; } ZIP_EXTERN int zip_register_progress_callback_with_state(zip_t *za, double precision, zip_progress_callback callback, void (*ud_free)(void *), void *ud) { zip_progress_t *progress = NULL; if (callback != NULL) { if (za->progress == NULL) { if ((za->progress = _zip_progress_new(za)) == NULL) { return -1; } } _zip_progress_set_progress_callback(za->progress, precision, callback, ud_free, ud); } else { if (za->progress != NULL) { if (za->progress->callback_cancel == NULL) { _zip_progress_free(za->progress); za->progress = NULL; } else { _zip_progress_free_progress_callback(za->progress); } } } return 0; } ZIP_EXTERN int zip_register_cancel_callback_with_state(zip_t *za, zip_cancel_callback callback, void (*ud_free)(void *), void *ud) { zip_progress_t *progress = NULL; if (callback != NULL) { if (za->progress == NULL) { if ((za->progress = _zip_progress_new(za)) == NULL) { return -1; } } _zip_progress_set_cancel_callback(za->progress, callback, ud_free, ud); } else { if (za->progress != NULL) { if (za->progress->callback_progress == NULL) { _zip_progress_free(za->progress); za->progress = NULL; } else { _zip_progress_free_cancel_callback(za->progress); } } } return 0; } struct legacy_ud { zip_progress_callback_t callback; }; static void _zip_legacy_progress_callback(zip_t *za, double progress, void *vud) { struct legacy_ud *ud = (struct legacy_ud *)vud; ud->callback(progress); } ZIP_EXTERN void zip_register_progress_callback(zip_t *za, zip_progress_callback_t progress_callback) { struct legacy_ud *ud; if (progress_callback == NULL) { zip_register_progress_callback_with_state(za, 0, NULL, NULL, NULL); } if ((ud = (struct legacy_ud *)malloc(sizeof(*ud))) == NULL) { return; } ud->callback = progress_callback; if (zip_register_progress_callback_with_state(za, 0.001, _zip_legacy_progress_callback, free, ud) < 0) { free(ud); } } 132'>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