summaryrefslogtreecommitdiffstats
path: root/src/Components/AlterOperation.php
blob: d704f25ba213e189fbcfa8747c132bd6436b4b7d (plain)
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
<?php

/**
 * Parses an alter operation.
 *
 * @package    SqlParser
 * @subpackage Components
 */
namespace SqlParser\Components;

use SqlParser\Component;
use SqlParser\Parser;
use SqlParser\Token;
use SqlParser\TokensList;

/**
 * Parses an alter operation.
 *
 * @category   Components
 * @package    SqlParser
 * @subpackage Components
 * @author     Dan Ungureanu <udan1107@gmail.com>
 * @license    http://opensource.org/licenses/GPL-2.0 GNU Public License
 */
class AlterOperation extends Component
{

    /**
     * All alter operations.
     *
     * @var array
     */
    public static $OPTIONS = array(
        'ADD'                           => 3,
        'ALTER'                         => 3,
        'ANALYZE'                       => 3,
        'CHANGE'                        => 3,
        'CHECK'                         => 3,
        'COALESCE'                      => 3,
        'CONVERT'                       => 3,
        'DISABLE'                       => 3,
        'DISCARD'                       => 3,
        'DROP'                          => 3,
        'ENABLE'                        => 3,
        'IMPORT'                        => 3,
        'MODIFY'                        => 3,
        'OPTIMIZE'                      => 3,
        'ORDER'                         => 3,
        'PARTITION'                     => 3,
        'REBUILD'                       => 3,
        'REMOVE'                        => 3,
        'RENAME'                        => 3,
        'REORGANIZE'                    => 3,
        'REPAIR'                        => 3,

        'COLUMN'                        => 4,
        'CONSTRAINT'                    => 4,
        'DEFAULT'                       => 4,
        'TO'                            => 4,
        'BY'                            => 4,
        'FOREIGN'                       => 4,
        'FULLTEXT'                      => 4,
        'KEY'                           => 4,
        'KEYS'                          => 4,
        'PARTITIONING'                  => 4,
        'PRIMARY KEY'                   => 4,
        'SPATIAL'                       => 4,
        'TABLESPACE'                    => 4,
        'INDEX'                         => 4,

        'DEFAULT CHARACTER SET'         => array(5, 'var'),
        'DEFAULT CHARSET'               => array(5, 'var'),

        'COLLATE'                       => array(6, 'var'),
    );

    /**
     * Options of this operation.
     *
     * @var OptionsArray
     */
    public $options;

    /**
     * The altered field.
     *
     * @var Expression
     */
    public $field;

    /**
     * Unparsed tokens.
     *
     * @var Token[]|string
     */
    public $unknown = array();

    /**
     * @param Parser     $parser  The parser that serves as context.
     * @param TokensList $list    The list of tokens that are being parsed.
     * @param array      $options Parameters for parsing.
     *
     * @return AlterOperation
     */
    public static function parse(Parser $parser, TokensList $list, array $options = array())
    {
        $ret = new AlterOperation();

        /**
         * Counts brackets.
         * @var int $brackets
         */
        $brackets = 0;

        /**
         * The state of the parser.
         *
         * Below are the states of the parser.
         *
         *      0 ---------------------[ options ]---------------------> 1
         *
         *      1 ----------------------[ field ]----------------------> 2
         *
         *      2 -------------------------[ , ]-----------------------> 0
         *
         * @var int
         */
        $state = 0;

        for (; $list->idx < $list->count; ++$list->idx) {
            /**
             * Token parsed at this moment.
             * @var Token $token
             */
            $token = $list->tokens[$list->idx];

            // End of statement.
            if ($token->type === Token::TYPE_DELIMITER) {
                break;
            }

            // Skipping comments.
            if ($token->type === Token::TYPE_COMMENT) {
                continue;
            }

            // Skipping whitespaces.
            if ($token->type === Token::TYPE_WHITESPACE) {
                if ($state === 2) {
                    // When parsing the unknown part, the whitespaces are
                    // included to not break anything.
                    $ret->unknown[] = $token;
                }
                continue;
            }

            if ($state === 0) {
                $ret->options = OptionsArray::parse($parser, $list, static::$OPTIONS);
                $state = 1;
            } elseif ($state === 1) {
                $ret->field = Expression::parse(
                    $parser,
                    $list,
                    array(
                        'noAlias' => true,
                        'noBrackets' => true,
                    )
                );
                if ($ret->field === null) {
                    // No field was read. We go back one token so the next
                    // iteration will parse the same token, but in state 2.
                    --$list->idx;
                }
                $state = 2;
            } elseif ($state === 2) {
                if ($token->type === Token::TYPE_OPERATOR) {
                    if ($token->value === '(') {
                        ++$brackets;
                    } elseif ($token->value === ')') {
                        --$brackets;
                    } elseif (($token->value === ',') && ($brackets === 0)) {
                        break;
                    }
                }
                $ret->unknown[] = $token;
            }
        }

        if ($ret->options->isEmpty()) {
            $parser->error(
                __('Unrecognized alter operation.'),
                $list->tokens[$list->idx]
            );
            return null;
        }

        --$list->idx;
        return $ret;
    }

    /**
     * @param AlterOperation $component The component to be built.
     *
     * @return string
     */
    public static function build($component)
    {
        $ret = OptionsArray::build($component->options) . ' ';
        if (!empty($component->field)) {
            $ret .= Expression::build($component->field) . ' ';
        }
        $ret .= TokensList::build($component->unknown);
        return $ret;
    }
}