/**************************************************************************** ** ** Copyright (C) 2016 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Device Utilities module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:GPL$ ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and The Qt Company. For licensing terms ** and conditions see https://www.qt.io/terms-conditions. For further ** information use the contact form at https://www.qt.io/contact-us. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 3 or (at your option) any later version ** approved by the KDE Free Qt Foundation. The licenses are as published by ** the Free Software Foundation and appearing in the file LICENSE.GPL3 ** included in the packaging of this file. Please review the following ** information to ensure the GNU General Public License requirements will ** be met: https://www.gnu.org/licenses/gpl-3.0.html. ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #ifndef QNETWORKSETTINGSMANAGER_H #define QNETWORKSETTINGSMANAGER_H #include "qnetworksettings.h" #include #include QT_FORWARD_DECLARE_CLASS(QNetworkSettingsManagerPrivate) QT_FORWARD_DECLARE_CLASS(QNetworkSettingsService) QT_FORWARD_DECLARE_CLASS(QNetworkSettingsServiceModel) QT_FORWARD_DECLARE_CLASS(QNetworkSettingsUserAgent) QT_FORWARD_DECLARE_CLASS(QNetworkSettingsServiceFilter) QT_FORWARD_DECLARE_CLASS(QNetworkSettingsInterfaceModel) class Q_DECL_EXPORT QNetworkSettingsManager : public QObject { Q_OBJECT Q_ENUMS(StateTypes NetworkTypeTypes) Q_PROPERTY(QNetworkSettingsServiceFilter* services READ services NOTIFY servicesChanged) Q_PROPERTY(QNetworkSettingsInterfaceModel* interfaces READ interfaces NOTIFY interfacesChanged) Q_PROPERTY(QNetworkSettingsUserAgent* userAgent READ userAgent CONSTANT) public: explicit QNetworkSettingsManager(QObject* parent = Q_NULLPTR); QNetworkSettingsServiceFilter* services(); QNetworkSettingsInterfaceModel* interfaces(); void setUserAgent(QNetworkSettingsUserAgent *agent); QNetworkSettingsUserAgent* userAgent(); Q_INVOKABLE QNetworkSettingsService* service(const QString& name, const int type); Q_SIGNALS: void servicesChanged(); void interfacesChanged(); protected: QNetworkSettingsManagerPrivate *d_ptr; private: Q_DISABLE_COPY(QNetworkSettingsManager) Q_DECLARE_PRIVATE(QNetworkSettingsManager) }; #endif // QNETWORKSETTINGSMANAGER_H href='#n19'>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

#!/usr/bin/env perl
#############################################################################
##
## Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
## Contact: http://www.qt-project.org/legal
##
## This file is part of the test suite of the Qt Toolkit.
##
## $QT_BEGIN_LICENSE:LGPL$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and Digia.  For licensing terms and
## conditions see http://qt.digia.com/licensing.  For further information
## use the contact form at http://qt.digia.com/contact-us.
##
## GNU Lesser General Public License Usage
## Alternatively, this file may be used under the terms of the GNU Lesser
## General Public License version 2.1 as published by the Free Software
## Foundation and appearing in the file LICENSE.LGPL included in the
## packaging of this file.  Please review the following information to
## ensure the GNU Lesser General Public License version 2.1 requirements
## will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
##
## In addition, as a special exception, Digia gives you certain additional
## rights.  These rights are described in the Digia Qt LGPL Exception
## version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
##
## GNU General Public License Usage
## Alternatively, this file may be used under the terms of the GNU
## General Public License version 3.0 as published by the Free Software
## Foundation and appearing in the file LICENSE.GPL included in the
## packaging of this file.  Please review the following information to
## ensure the GNU General Public License version 3.0 requirements will be
## met: http://www.gnu.org/copyleft/gpl.html.
##
##
## $QT_END_LICENSE$
##
#############################################################################

use strict;
use warnings;
use 5.008;

#==============================================================================
package QtQATest;

use File::Basename;
use File::Spec;
use FindBin;
use Cwd qw(abs_path getcwd);
use Getopt::Long;
use Data::Dumper;
use Carp qw(croak);

use constant CONFDIR => $FindBin::RealBin;

use constant TOKEN_LITERAL     => "literal";
use constant TOKEN_PROPERTY    => "property";
use constant TOKEN_ENVIRONMENT => "environment";

use constant SOURCE_FILE        =>  "file";
use constant SOURCE_ENVIRONMENT =>  "environment";
use constant SOURCE_DEFAULT     =>  "default value";

sub new
{
    my $class = shift;
    my %opts = @_;
    $opts{properties} = {};
    if (!$opts{confdir}) {
        $opts{confdir} = CONFDIR;
    }
    bless \%opts, $class;
}

# Transform a Pulse project or stage name into a filesystem-safe handle
sub _handleize
{
    my $self = shift;
    my $out = shift;

    $out =~ s/[^a-zA-Z0-9_\-+.]/_/g;

    return $out;
}

# Return first line (chomped) of the given file, or die.
sub _filecontents
{
    my $self = shift;
    my $filename = shift;

    my $realfilename = $self->_follow_symlinks($filename);

    my $fh;
    open $fh, "<$realfilename" or croak "open $realfilename: $!\n"
        .(($filename ne $realfilename) ? "  ($realfilename is dest of symlink $filename)\n" : "");
    my $value = <$fh>;
    close $fh;

    if (defined($value)) {
        chomp $value;
    }

    return $value;
}

# Read environment variables from the given directory.
sub _readenvironment
{
    my $self = shift;
    my $directory = shift;

    eval {
        my $newdirectory = $self->_follow_symlinks($directory);
        $directory = $newdirectory if $newdirectory;
    };

    # Directory is allowed to not exist.
    if (! -e $directory) {
        return;
    }

    if (! -d $directory) {
        die "$directory exists but isn't a directory";
    }

    foreach my $file (glob "$directory/*") {
        next unless -f $file;

        my $environment = basename $file;
        my $value = $self->_filecontents($file);

        if ($environment =~ /^(PULSE|QTQA)_(.*)$/i) {
            my $prefix = $1;
            my $rest = lc $2;
            die "$file is named $environment\n"
                ."Please don't set `${prefix}_FOO' values with the environment directory; "
                ."if you want to set a property called $rest then use the properties directory";
        }

        $self->{environment}->{$environment} = {
            value       =>  $value,
            source      =>  SOURCE_FILE,
            filename    =>  $file,
        };
    }
}

# Read properties from the given directory.
sub _readproperties
{
    my $self = shift;
    my $directory = shift;
    my %opts = @_;

    eval {
        my $newdirectory = $self->_follow_symlinks($directory);
        $directory = $newdirectory if $newdirectory;
    };

    # Directory is allowed to not exist.
    if (! -e $directory) {
        return;
    }

    if (! -d $directory) {
        die "$directory exists but isn't a directory";
    }

    foreach my $file (glob "$directory/*") {
        next unless -f $file;

        my $property = basename $file;
        my $value = $self->_filecontents($file);

        my ($environment) = $self->_property_to_environment($property);
        if ($self->{useenv} && exists($ENV{$environment})) {
            warn "environment variable $environment overrides the value in $file";
        }
        else {
            if (exists($ENV{$environment})) {
                warn "environment variable $environment is set but will have no effect";
                if (!$self->{warnedenv}) {
                    $self->{warnedenv} = 1;
                    warn "If you want environment variables to be able to override configuration, "
                        ."you must run with the `--use-env' option";
                }
            }
            if (my $p = $self->{properties}->{$property}) {
                if (defined($p->{value}) && defined($value) && ($p->{value} ne $value) && $opts{warn_redefine}) {
                    warn "Property `$property' was redefined\n"
                        ."  New definition:      `$value' (from ".SOURCE_FILE." $file)\n"
                        ."  Previous definition: `".$p->{value}."' (from ".$p->{source}.
                            (($p->{source} eq SOURCE_FILE) ? " ".$p->{filename} : "").")"
                    ;
                }
            }
            $self->{properties}->{$property} = {
                value       =>  $value,
                source      =>  SOURCE_FILE,
                filename    =>  $file,
            };
        }
    }
}

sub _readenvironmentproperties
{
    my $self = shift;
    foreach my $key (keys %ENV) {
        $key = uc $key;
        next unless ($key =~ /^(?:PULSE|QTQA)_/i);

        # This environment variable is a property.
        # However, there's no unambiguous way to map it back to the property name,
        # since replacing . with _ is lossy.
        # To give the nicest looking results, we'll try to match against the properties we've read
        # from disk, plus a few other known property names
        my @known_properties = keys %{$self->{properties}};
        push @known_properties, "base.dir";
        my $property;
        OUTER: foreach my $propertyname (@known_properties) {
            my @this_env = $self->_property_to_environment($propertyname);
            foreach my $this_env (@this_env) {
                if ($this_env eq $key) {
                    $property = $propertyname;
                    last OUTER;
                }
            }
        }

        # if there's no matches, we'll just leave _ as-is, instead of trying to guess
        # which ones should be dots.
        if (!$property) {
            $property = $key;
            $property =~ s/^(?:PULSE|QTQA)_//;
            $property = lc $property;
        }

        if (!$self->{properties}->{$property} || $self->{useenv}) {
            $self->{properties}->{$property} = {
                value   =>  $ENV{$key},
                source  =>  SOURCE_ENVIRONMENT,
                env     =>  $key,
            }
        }
    }
}

# Read an optional value from any one of the given files.
# The first file which exists is used.
# If none of the files exist, an empty string is returned.
# Returns the value and the filename which was used.
sub _readoptionfile
{
    my $self = shift;
    my @filenames = @_;

    my $out = "";
    my $resolvedfilename;

    foreach my $filename (@filenames) {
        if (-f $filename) {
            $out = $self->_filecontents($filename);
            $resolvedfilename = $filename;
            last;
        }
    }

    if (wantarray) {
       return ($out, $resolvedfilename);
    }
    else {
        return $out;
    }
}

sub _parserepository
{
    my $self = shift;
    my $repository = shift;

    # repository string is this format:
    #
    #  uri/of/git/repo#gitbranch directoryname
    #
    # With the corresponding command(s) being:
    #
    #  git clone uri/of/git/repo directoryname
    #  cd directoryname
    #  git checkout -b local origin/gitbranch
    #

    my @split = split(/ +/, $repository);
    if (scalar(@split) != 2) {
        die "expected 2 space-separated elements, but got ".scalar(@split);
    }

    my $gitrepository = $split[0];
    my $gitlocaldirectory = $split[1];
    my $gitbranch;

    if ($gitrepository =~ /#/) {
        @split = split(/#/, $gitrepository);
        if (scalar(@split) != 2) {
            die "repository part `$gitrepository' should have 0 or 1 `#' characters";
        }
        $gitrepository = $split[0];
        $gitbranch = $split[1];
    }

    $self->{gitrepository} = $gitrepository;
    $self->{gitlocaldirectory} = $gitlocaldirectory;
    $self->{gitbranch} = $gitbranch;
}

# Follow msysgit's emulated symbolic links
sub _follow_symlinks
{
    my $self = shift;
    my $path = shift;

    # On Unix we can follow symlinks normally...
    if ($^O ne "MSWin32") {
        eval { $path = abs_path($path) };
        return $path;
    }

    my $existing_part = $path;
    while (! -e $existing_part) {
        my $new_existing_part = dirname($existing_part);
        last if ($new_existing_part eq $existing_part);
        $existing_part = $new_existing_part;
    }
    if (! -e $existing_part) {
        return $path;
    }

    my $existing_part_quoted = quotemeta($existing_part);
    my $rest = $path;
    $rest =~ s/^$existing_part_quoted//;

    eval { $existing_part = abs_path($existing_part) };

    # Given the path:
    #
    #  projects/Qt3d/stages/foobar
    #
    # ...where the `stages' part is a symlink, we now have
    #
    # $existing_part = projects/Qt3d/stages
    # $rest = /foobar


    # If $existing_part is a directory, it's not a symlink
    return $path if (-d $existing_part);

    my $fh;
    open $fh, "<$existing_part" or return $path;
    my $value = <$fh>;
    close $fh;

    chomp $value;

    if (!$value) {
        return $path;
    }

    # OK, now $existing_part is _possibly_ a symlink
    my $symlink_src = $existing_part;
    my $symlink_dest;
    eval { $symlink_dest = dirname(abs_path($symlink_src))."/$value" };
    if ($@) {
        return $path;
    }
    if (! -e $symlink_dest) {
        return $path;
    }

    my $created_cache = !exists($self->{_symlink_cache});
    if (exists($self->{_symlink_cache}->{$symlink_dest})) {
        die "cyclic reference in symbolic links";
    }
    $self->{_symlink_cache}->{$symlink_dest} = 1;

    my $out;
    eval {
        $out = $self->_follow_symlinks($symlink_dest);
    };
    my $error = $@;
    delete $self->{_symlink_cache} if $created_cache;

    if ($error) {
        die "while processing $symlink_dest (linked to from $symlink_src):\n $error";
    }

    $out .= $rest;

    eval { $out = abs_path($out) };

    return $out;
}

sub _format_parse_error {
    my $self = shift;
    my %opts = @_;

    my $input = $opts{input};
    my $errorposition = $opts{errorposition};
    my $errorstring = $opts{errorstring};

    my $out = $input;
    $out .= "\n";
    $out .= sprintf("%${errorposition}s^\n","");
    $out .= "error: $errorstring";

    return $out;
}

# Tokenize a property string and return a description of the tokens.
sub _tokenize_property
{
    my $self = shift;
    my $property = shift;

    my @tokens;
    my @chars;
    if (defined($property->{value})) {
        @chars = split(//, $property->{value});
    }

    use constant STATE_READING_LITERAL  =>  "reading_literal";
    use constant STATE_READING_ENVIRONMENT_CURLYBRACE =>  "reading_env_curlybrace";
    use constant STATE_READING_PROPERTY_PARENTHESIS =>  "reading_property_parenthesis";
    use constant STATE_SUBSTITUTION_MARKER  =>  "subst_marker";
    use constant STATE_ESCAPE_CHARACTER =>  "escape_character";

    my $current_token = "";
    my $state = STATE_READING_LITERAL;
    my $i = -1;

    while (@chars) {
        my $c = shift @chars;
        ++$i;


        if ($state eq STATE_READING_LITERAL)
        {
            if ($c eq '\\') {
                $state = STATE_ESCAPE_CHARACTER;
            }
            elsif ($c eq '$') {
                $state = STATE_SUBSTITUTION_MARKER;
            }

            # Are we still reading a literal?
            if ($state eq STATE_READING_LITERAL) {
                $current_token .= $c;
            }
            elsif ($current_token ne "") {
                push @tokens, {
                    type    =>  TOKEN_LITERAL,
                    data    =>  $current_token,
                };
                $current_token = "";
            }
        }

        elsif ($state eq STATE_READING_ENVIRONMENT_CURLYBRACE)
        {
            if ($c eq '}')
            {
                $state = STATE_READING_LITERAL;
                push @tokens, {
                    type    =>  TOKEN_ENVIRONMENT,
                    data    =>  $current_token,
                };
                $current_token = "";
            }
            else
            {
                $current_token .= $c;
            }
        }

        elsif ($state eq STATE_READING_PROPERTY_PARENTHESIS)
        {
            if ($c eq ')')
            {
                $state = STATE_READING_LITERAL;
                push @tokens, {
                    type    =>  TOKEN_PROPERTY,
                    data    =>  $current_token,
                };
                $current_token = "";
            }
            else
            {
                $current_token .= $c;
            }
        }

        elsif ($state eq STATE_SUBSTITUTION_MARKER) {
            if ($c eq '{') {
                $state = STATE_READING_ENVIRONMENT_CURLYBRACE;
            }
            elsif ($c eq '(') {
                $state = STATE_READING_PROPERTY_PARENTHESIS;
            }
            else {
                die $self->_format_parse_error(
                    input           =>  $property->{value},
                    errorposition   =>  $i,
                    errorstring     =>
                        "expected { or (, got $c\n"
                        ."(maybe you need \\\$$c instead of \$$c ?)"
                );
            }
        }


        elsif ($state eq STATE_ESCAPE_CHARACTER) {
            if (!($c =~ /[\\\$]/)) {
                die $self->_format_parse_error(
                    input           =>  $property->{value},
                    errorposition   =>  $i-1,
                    errorstring     =>
                        "useless use of \\\n"
                        ."(I saw \\$c; if you wanted $c then put $c; if you wanted \\$c then put \\\\$c)"
                );
            }
            push @tokens, {
                type    =>  TOKEN_LITERAL,
                data    =>  $c,
            };
            $current_token = "";
            $state = STATE_READING_LITERAL;
        }


        else {
            die $self->_format_parse_error(
                input           =>  $property->{value},
                errorposition   =>  $i,
                errorstring     => "internal error: parser in unknown state $state",
            );
        }
    }



    # We're done; we should have always finished on STATE_READING_LITERAL
    if ($state eq STATE_READING_LITERAL) {
        if ($current_token ne "") {
            push @tokens, {
                type    =>  TOKEN_LITERAL,
                data    =>  $current_token,
            };
            $current_token = "";
        }
    }
    elsif ($state eq STATE_READING_ENVIRONMENT_CURLYBRACE) {
        die $self->_format_parse_error(
            input           =>  $property->{value},
            errorposition   =>  $i+1,
            errorstring     => "got end of string, expected `}'",
        );
    }
    elsif ($state eq STATE_READING_PROPERTY_PARENTHESIS) {
        die $self->_format_parse_error(
            input           =>  $property->{value},
            errorposition   =>  $i+1,
            errorstring     => "got end of string, expected `)'",
        );
    }
    elsif ($state eq STATE_SUBSTITUTION_MARKER) {
        die $self->_format_parse_error(
            input           =>  $property->{value},
            errorposition   =>  $i+1,
            errorstring     =>
                "got end of string, expected `(' or `{'\n"
                ."(last character in string was \$, did you mean \\\$ ?)"
        );
    }
    elsif ($state eq STATE_ESCAPE_CHARACTER) {
        die $self->_format_parse_error(
            input           =>  $property->{value},
            errorposition   =>  $i+1,
            errorstring     =>
                "got end of string, expected some character\n"
                ."(last character in string was \\, did you mean \\\\ ?)"
        );
    }
    else {
        die $self->_format_parse_error(
            input           =>  $property->{value},
            errorposition   =>  $i+1,
            errorstring     =>
                "internal error at end of string: parser ended in unexpected state $state"
        );
    }


    my %out = %{$property};
    $out{tokens} = \@tokens;
    return \%out;
}

sub _relative_filename
{
    my $self = shift;
    my $filename = shift;

    my $prefix = $self->{confdir};
    $filename =~ s|^$prefix/?||;

    return $filename;
}

sub _tokenize_or_die
{
    my $self = shift;
    my %opts = @_;

    my $key = $opts{key};
    my $thing = $opts{thing};
    my $type = $opts{type};

    my $tokenized_thing;
    eval { $tokenized_thing = $self->_tokenize_property($thing) };
    if ($@) {
        die sprintf("while parsing %s `%s' (sourced from %s%s):\n%s",
            $type,
            $key,
            $thing->{source},
            ($thing->{source} eq SOURCE_FILE) ? (" ".$self->_relative_filename($thing->{filename})) : "",
            $@
        );
    }

    return $tokenized_thing;
}

sub _resolve_property
{
    my $self = shift;
    my %opts = @_;

    my $property = $opts{to_resolve};
    my $unresolved_properties = $opts{unresolved};
    my $input_properties = $opts{input};

    my @tokens = @{$property->{tokens}};
    if (scalar(@tokens) == 0) {
        return "";
    }

    my $resolved = undef;
    foreach my $token (@tokens) {
        if ($token->{type} eq TOKEN_LITERAL) {
            defined($resolved) or $resolved = "";
            $resolved .= $token->{data};
        }
        elsif ($token->{type} eq TOKEN_PROPERTY) {
            my $data = $token->{data};
            if (exists $input_properties->{$data}) {
                defined($resolved) or $resolved = "";
                $resolved .= $input_properties->{$data}->{value};
            }
            elsif (exists $unresolved_properties->{$data}) {
                $resolved = undef;
                last;
            }
            else {
                # property does not exist at all - just use an empty value.
                defined($resolved) or $resolved = "";
            }
        }
        elsif ($token->{type} eq TOKEN_ENVIRONMENT) {
            my $data = $token->{data};
            if (exists $ENV{$data}) {
                $resolved .= $ENV{$data};
            }
            else {
                defined($resolved) or $resolved = "";
            }
        }
    }

    return $resolved;
} 

# Look through all properties and environment variables and resolve $(references)
# to the referenced property.
# Also removes escape characters.
sub _resolve_property_references
{
    my $self = shift;

    my $all_properties = $self->{properties};
    my $resolved_properties;
    my $unresolved_properties;

    foreach my $key (keys %{$all_properties}) {
        my $property = $all_properties->{$key};

        # We don't touch properties which come from anywhere but files.
        # The reason is that properties set in Pulse will come from the
        # environment, and may have been parsed once already by that point.
        # If we parsed them here, they would potentially be parsed twice,
        # and there would be much confusion about where they should be parsed,
        # how many escape characters need to be used, etc.
        if ($property->{source} ne SOURCE_FILE) {
            $resolved_properties->{$key} = $property;
            next;
        }

        $unresolved_properties->{$key} = $self->_tokenize_or_die(
            key     =>  $key,
            thing   =>  $property,
            type    =>  "property",
        );
    }

    my $all_environment = $self->{environment};
    my $unresolved_environment;
    my $resolved_environment;

    foreach my $key (keys %{$all_environment}) {
        my $environment = $all_environment->{$key};

        $unresolved_environment->{$key} = $self->_tokenize_or_die(
            key     =>  $key,
            thing   =>  $environment,
            type    =>  "environment variable",
        );
    }

    # Check tokenization here if unsure :-)
    #print STDERR Dumper($unresolved_properties, $unresolved_environment);

    # To avoid the code complexity of generating a dependency graph between
    # properties, we'll simply use an inefficient approach of repeatedly iterating
    # through all unresolved properties until it looks like we can't do any more.
    my $did_something = 1;
    while ($did_something && (scalar keys %{$unresolved_properties})) {
        $did_something = 0;

        foreach my $key (keys %{$unresolved_properties}) {
            my $to_resolve = $unresolved_properties->{$key};
            my $resolved = $self->_resolve_property(
                to_resolve  =>  $to_resolve,
                unresolved  =>  $unresolved_properties,
                input       =>  $resolved_properties,
            );
            if (defined($resolved)) {
                $to_resolve->{value} = $resolved;
                $resolved_properties->{$key} = $to_resolve;
                delete $unresolved_properties->{$key};
                $did_something = 1;
            }
        }
    }


    # If there are still unresolved properties, then we didn't manage to resolve
    # anything at the last pass - there must be cyclic dependencies.
    if (scalar keys %{$unresolved_properties}) {
        my $property_description = "";
        my $sep = "";
        foreach my $key (keys %{$unresolved_properties}) {
            $property_description .= $sep;
            $sep = ", ";

            my $property = $unresolved_properties->{$key};

            $property_description .= "$key";
            $property_description .= " (from ".$property->{source}.(
                ($property->{source} eq SOURCE_FILE)
                    ? (" ".$property->{filename})
                    : ""
            );
            $property_description .= ")";
        }
        die "cyclic dependency detected between these properties: $property_description";
    }

    # Resolve environment;
    # these can refer to properties, but can't refer to each other.
    foreach my $key (keys %{$unresolved_environment}) {
        my $to_resolve = $unresolved_environment->{$key};

        my $resolved = $self->_resolve_property(
            to_resolve  =>  $to_resolve,
            unresolved  =>  {},
            input       =>  $resolved_properties,
        );

        # This should never happen... (cyclic dependencies are not possible here)
        defined($resolved) or die "internal error: resolving environment `$key' failed";

        $to_resolve->{value} = $resolved;
        $resolved_environment->{$key} = $to_resolve;
        delete $unresolved_environment->{$key};
    }

    $self->{properties} = $resolved_properties;
    $self->{environment} = $resolved_environment;
}

sub _setdefaultproperties
{
    my $self = shift;
    my $properties = $self->{properties};

    # There are a few properties which Pulse sets every time.
    # If we're running the script locally, we should set these for the user if
    # the value is predictable.  Otherwise, any references to these from other
    # properties would be replaced with an empty string.
    if (!exists($properties->{'base.dir'}) && !exists($properties->{base_dir})) {
        $properties->{'base.dir'} = {
            value   =>  File::Spec->canonpath(getcwd),
            source  =>  SOURCE_DEFAULT,
        };
    }
}

# Return true if it looks like we're in Pulse.
sub _in_pulse
{
    my $self = shift;

    if ($self->{force_in_pulse}) {
        return 1;
    }

    return exists($ENV{PULSE_BUILD_NUMBER}) && exists($ENV{PULSE_BUILD_REASON});
}

sub _read_inheritance_tree
{
    my $self = shift;

    my $dir = shift;
    
    my %seen;
    my @out;

    my $thisdir;
    eval { $thisdir = $self->_follow_symlinks($dir) };
    if (!$thisdir || ! -d $thisdir) {
        return @out;
    }

    unshift @out, $thisdir;
    $seen{$thisdir} = 1;

    my $inherits = "$thisdir/inherits";
    while (-e($inherits) || -l($inherits)) {
        eval { $thisdir = $self->_follow_symlinks($inherits) };
        if ($@) {
            die "Broken inheritance link `$inherits': $@";
        }
        if (! -e($thisdir) && ! -l($thisdir)) {
            die "$inherits points to non-existent target $thisdir";
        }
        if ($seen{$thisdir}) {
            die "Cyclic inheritance detected between ".join(", ",(sort keys %seen));
        }
        $seen{$thisdir} = 1;
        unshift @out, $thisdir;
        $inherits = "$thisdir/inherits";
    }

    return @out;
}

sub _readconfig
{
    my $self = shift;

    my $project = $self->{project};
    my $stage = $self->{stage};
    my $confdir = $self->{confdir};

    my @stagedirs;

    my $thisprojectdir = $self->_follow_symlinks("$confdir/projects/".$self->_handleize($project));
    if (! -d $thisprojectdir) {
        die "project directory $thisprojectdir doesn't exist or isn't a directory";
    }