├── src ├── fields │ ├── oembed.php │ ├── wysiwyg.php │ ├── textarea.php │ ├── default.php │ ├── text.php │ ├── url.php │ ├── repeater.php │ └── link.php ├── block.php └── ACFBlockCreator.php ├── .github └── assets │ └── usage-demo.gif ├── .gitattributes ├── .editorconfig ├── composer.json ├── CHANGELOG.md ├── assets └── js │ └── acf-block-creator.js ├── .gitignore ├── phpcs.xml ├── README.md ├── composer.lock └── LICENSE /src/fields/oembed.php: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /src/fields/wysiwyg.php: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /src/fields/textarea.php: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /src/fields/default.php: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /src/fields/text.php: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /src/fields/url.php: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /.github/assets/usage-demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/micropackage/acf-block-creator/HEAD/.github/assets/usage-demo.gif -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text eol=lf 2 | *.gif -text 3 | *.ico -text 4 | *.jpg -text 5 | *.pdf -text 6 | *.png -text 7 | *.psd -text 8 | *.webp -text 9 | -------------------------------------------------------------------------------- /src/block.php: -------------------------------------------------------------------------------- 1 | 9 | 10 |
11 | 12 | {FIELDS} 13 | 14 |
15 | -------------------------------------------------------------------------------- /src/fields/repeater.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | {subfields} 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | end_of_line = lf 6 | insert_final_newline = true 7 | trim_trailing_whitespace = true 8 | indent_style = tab 9 | 10 | [{*.txt,wp-config-sample.php}] 11 | end_of_line = crlf 12 | 13 | [*.yml] 14 | indent_style = space 15 | indent_size = 2 16 | -------------------------------------------------------------------------------- /src/fields/link.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "micropackage/acf-block-creator", 3 | "description": "ACF Block Creator - automatic block creation add-on for ACF", 4 | "license": "GPL-3.0-or-later", 5 | "authors": [ 6 | { 7 | "name": "Jakub Mikita", 8 | "email": "jakub@bracketspace.com" 9 | }, 10 | { 11 | "name": "Wojtek Szałkiewicz", 12 | "email": "wojtek@szalkiewicz.pl" 13 | } 14 | ], 15 | "scripts": { 16 | "phpcs": "phpcs", 17 | "phpcbf": "phpcbf" 18 | }, 19 | "require": { 20 | "php": ">=5.6", 21 | "micropackage/singleton": "^1.1", 22 | "micropackage/dochooks": "^1.0", 23 | "micropackage/filesystem": "^1.0" 24 | }, 25 | "require-dev": { 26 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0", 27 | "phpcompatibility/php-compatibility": "^9.1", 28 | "wp-coding-standards/wpcs": "^2.0" 29 | }, 30 | "autoload": { 31 | "psr-4" : { 32 | "Micropackage\\ACFBlockCreator\\" : "src" 33 | } 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | All notable changes to this project will be documented in this file. 3 | 4 | ## 1.0.7 5 | 6 | * [Fixed] Fixed PHP deprecation notices. 7 | 8 | ## 1.0.6 9 | 10 | * [Added] Filers for block template and final markup. 11 | 12 | ## 1.0.5 13 | 14 | * [Fixed] Invalid `micropackage/acf-block-creator/config` hookname 15 | * [Added] Filters for block template and style file paths 16 | 17 | ## 1.0.4 18 | 19 | * [Fixed] block setup fields behavior 20 | * [Added] filters for config and save directory 21 | 22 | ## 1.0.3 23 | 24 | * [Fixed] jQuery compatibility in WordPress 5.5. 25 | * [Fixed] ACF 5.9 compatibility. 26 | * [Fixed] Block creation when using layout fields like Message or Tabs. 27 | * [Changed] Block template. 28 | * [Added] Support for line indentation. 29 | 30 | ## 1.0.2 31 | 32 | * [Added] InnerBlocks support. 33 | 34 | ## 1.0.1 35 | 36 | * [Added] stylelint-disable comment in scss file. 37 | 38 | ## 1.0.0 39 | 40 | Initial release 41 | -------------------------------------------------------------------------------- /assets/js/acf-block-creator.js: -------------------------------------------------------------------------------- 1 | ( function( $ ) { 2 | 3 | var $block_option_fields = $( '#acf-field-group-options .acf-fields' ).find( '[data-name="block_name"], [data-name="block_slug"], [data-name="block_category"], [data-name="block_align"], [data-name="block_container_class"], [data-name="inner_blocks"]' ); 4 | 5 | $block_option_fields.hide(); 6 | 7 | $( '#title' ).keyup( function() { 8 | var title = $( this ).val(); 9 | if ( 0 === title.indexOf( 'Block:' ) ) { 10 | $( '#acf_field_group-block_name' ).val( title.replace( 'Block: ', '' ) ).trigger( 'change' ); 11 | if ( ! $( '#acf_field_group-create_gutenberg_block' ).prop( 'checked' ) ) { 12 | $( '#acf_field_group-create_gutenberg_block' ).trigger( 'click' ); 13 | } 14 | } 15 | } ); 16 | 17 | $( '#acf_field_group-create_gutenberg_block' ).change( function() { 18 | if ( this.checked ) { 19 | $block_option_fields.show(); 20 | } else { 21 | $block_option_fields.hide(); 22 | } 23 | } ); 24 | 25 | $( '#acf_field_group-block_name ' ).change( function() { 26 | var block_slug = $( this ).val().toLowerCase() 27 | .replace( /\s+/g, '-' ) 28 | .replace( /[^\w\-]+/g, '' ) 29 | .replace( /\-\-+/g, '-' ) 30 | .replace( /^-+/, '' ) 31 | .replace( /-+$/, '' ); 32 | $( '#acf_field_group-block_slug' ).val( block_slug ); 33 | } ); 34 | 35 | } )( jQuery ); 36 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### Project ### 2 | *.log 3 | /vendor/ 4 | 5 | ### Windows ### 6 | # Windows image file caches 7 | Thumbs.db 8 | ehthumbs.db 9 | 10 | # Folder config file 11 | Desktop.ini 12 | 13 | # Recycle Bin used on file shares 14 | $RECYCLE.BIN/ 15 | 16 | # Windows Installer files 17 | *.cab 18 | *.msi 19 | *.msm 20 | *.msp 21 | 22 | # Windows shortcuts 23 | *.lnk 24 | 25 | 26 | ### macOS ### 27 | *.DS_Store 28 | .AppleDouble 29 | .LSOverride 30 | 31 | # Icon must end with two \r 32 | Icon 33 | 34 | 35 | # Thumbnails 36 | ._* 37 | 38 | # Files that might appear in the root of a volume 39 | .DocumentRevisions-V100 40 | .fseventsd 41 | .Spotlight-V100 42 | .TemporaryItems 43 | .Trashes 44 | .VolumeIcon.icns 45 | .com.apple.timemachine.donotpresent 46 | 47 | # Directories potentially created on remote AFP share 48 | .AppleDB 49 | .AppleDesktop 50 | Network Trash Folder 51 | Temporary Items 52 | .apdisk 53 | 54 | 55 | ### Sass ### 56 | .sass-cache/ 57 | *.css.map 58 | 59 | 60 | ### SublimeText ### 61 | # cache files for sublime text 62 | *.tmlanguage.cache 63 | *.tmPreferences.cache 64 | *.stTheme.cache 65 | 66 | # workspace files are user-specific 67 | *.sublime-workspace 68 | .vscode 69 | 70 | # project files should be checked into the repository, unless a significant 71 | # proportion of contributors will probably not be using SublimeText 72 | # *.sublime-project 73 | 74 | # sftp configuration file 75 | sftp-config.json 76 | 77 | # postcss sorting config file 78 | settings.json 79 | 80 | # Package control specific files 81 | Package Control.last-run 82 | Package Control.ca-list 83 | Package Control.ca-bundle 84 | Package Control.system-ca-bundle 85 | Package Control.cache/ 86 | Package Control.ca-certs/ 87 | bh_unicode_properties.cache 88 | 89 | # Sublime-github package stores a github token in this file 90 | # https://packagecontrol.io/packages/sublime-github 91 | GitHub.sublime-settings 92 | 93 | 94 | ### Vim ### 95 | # swap 96 | [._]*.s[a-w][a-z] 97 | [._]s[a-w][a-z] 98 | # session 99 | Session.vim 100 | # temporary 101 | .netrwhist 102 | *~ 103 | # auto-generated tag files 104 | tags 105 | -------------------------------------------------------------------------------- /phpcs.xml: -------------------------------------------------------------------------------- 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 | /src/fields/* 32 | 33 | 34 | 35 | /src/fields/* 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | . 45 | 46 | 47 | 48 | 49 | tests/* 50 | vendor/* 51 | src/block.php 52 | 53 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ACF Block Creator 2 | 3 | [![BracketSpace Micropackage](https://img.shields.io/badge/BracketSpace-Micropackage-brightgreen)](https://bracketspace.com) 4 | [![Latest Stable Version](https://poser.pugx.org/micropackage/acf-block-creator/v/stable)](https://packagist.org/packages/micropackage/acf-block-creator) 5 | [![PHP from Packagist](https://img.shields.io/packagist/php-v/micropackage/acf-block-creator.svg)](https://packagist.org/packages/micropackage/acf-block-creator) 6 | [![Total Downloads](https://poser.pugx.org/micropackage/acf-block-creator/downloads)](https://packagist.org/packages/micropackage/acf-block-creator) 7 | [![License](https://poser.pugx.org/micropackage/acf-block-creator/license)](https://packagist.org/packages/micropackage/acf-block-creator) 8 | 9 |

10 | Micropackage logo 11 |

12 | 13 | ## 🧬 About ACF Block Creator 14 | 15 | This package simplifies block creation for Gutengberg editor in WordPress using Advanced Custom Fields plugin. 16 | It extends functonality of [Block Loader](https://github.com/micropackage/block-loader) package and is intended to use alongside it. 17 | 18 | This package will automatically create a block template file with basic markup for ACF fields while creating a field group for a block. 19 | 20 | ## 💾 Installation 21 | 22 | ``` bash 23 | composer require --dev micropackage/acf-block-creator 24 | ``` 25 | 26 | ## 🕹 Usage 27 | 28 | Before you can start creating blocks this package needs to be initialized: 29 | ```php 30 | Micropackage\ACFBlockCreator\ACFBlockCreator::init( [ 31 | 'blocks_dir' => 'blocks', 32 | 'scss_dir' => false, 33 | 'default_category' => 'common', 34 | 'block_container_class' => 'block-inner', 35 | 'package' => true, 36 | 'license' => 'GPL-3.0-or-later', 37 | ] ); 38 | ``` 39 | 40 | Only thing to do is to create new ACF field group which name starts with "Block:". It will automatically create a block template file and set the field group location to this created block. 41 | 42 | Block params (block name, slug, category etc.) can be adjusted using additional fields at the bottom of field group creation form. 43 | 44 | ![ACF Block Creator demo](./.github/assets/usage-demo.gif?raw=true) 45 | 46 | ### Silent initialization 47 | 48 | Since this is a development package and is not useful in production environment we probably don't want it's initialization code in the production package of our theme. 49 | That's why this package will be automatically initialized by [Block Loader](https://github.com/micropackage/block-loader) if both packages will be present. 50 | 51 | So if we will add this as dev dependency and then run `composer install --no-dev` this package will not be present and just won't get loaded by BlockLoader. 52 | 53 | All configuration params of this package can be then passed directly to `BlockLoader::init` method. 54 | 55 | Also `blocks_dir` param will not be necessary since it will automatically get the value of `dir` param for BlockLoader. 56 | If you configure a custom category it will also be automatically used as default category for new blocks. 57 | 58 | ## ⚙️ Configuration 59 | All parameters are optional. 60 | 61 | | Parameter | Type | Description | 62 | | ------------------------- | ----------------- | ------------------------------------------------------------ | 63 | | **blocks_dir** | (*string*) | Directory inside the theme for block templates.
**Default:** `'blocks'` | 64 | | **scss_dir** | (*false\|string*) | Directory inside the theme for block sass styles file.
If set, the empty scss file will be created for each block in this directory.
**Default:** `false` | 65 | | **default_category** | (*string*) | Default category for new blocks.
**Default:** `'common'` | 66 | | **block_container_class** | (*string*) | Optional class for wrapping `
` element inside the block template.
**Default:** `'block-inner'` | 67 | | **package** | (*bool\|string*) | String containing package name for file block comment. If set to true, WordPress site name will be used. If false, no `@package` comment will be added.
**Default:** `true` | 68 | | **license** | (*false\|string*) | String containing license name for file block comment. If set to false no `@license` comment will be added.
**Default:** `'GPL-3.0-or-later'` | 69 | 70 | 71 | 72 | ## 📦 About the Micropackage project 73 | 74 | Micropackages - as the name suggests - are micro packages with a tiny bit of reusable code, helpful particularly in WordPress development. 75 | 76 | The aim is to have multiple packages which can be put together to create something bigger by defining only the structure. 77 | 78 | Micropackages are maintained by [BracketSpace](https://bracketspace.com). 79 | 80 | ## 📖 Changelog 81 | 82 | [See the changelog file](./CHANGELOG.md). 83 | 84 | ## 📃 License 85 | 86 | GNU General Public License (GPL) v3.0. See the [LICENSE](./LICENSE) file for more information. 87 | -------------------------------------------------------------------------------- /src/ACFBlockCreator.php: -------------------------------------------------------------------------------- 1 | config = apply_filters( 79 | 'micropackage/acf-block-creator/config', 80 | wp_parse_args( $config, [ 81 | 'blocks_dir' => 'blocks', 82 | 'scss_dir' => false, 83 | 'default_category' => 'common', 84 | 'block_container_class' => 'block-inner', 85 | 'package' => true, 86 | 'license' => 'GPL-3.0-or-later', 87 | 'root_dir' => get_stylesheet_directory(), 88 | ] ) 89 | ); 90 | 91 | $root_dir = apply_filters( 'micropackage/acf-block-creator/root-dir', $this->config['root_dir'] ); 92 | 93 | $this->package_fs = new Filesystem( __DIR__ ); 94 | $this->root_fs = new Filesystem( $root_dir ); 95 | 96 | Helper::hook( $this ); 97 | } 98 | 99 | /** 100 | * Initiates Block Loader 101 | * 102 | * @action acf/render_field_group_settings 103 | * 104 | * @since 1.0.0 105 | * @param array $field_group Field group params. 106 | * @return void 107 | */ 108 | public function render_field_group_settings( $field_group ) { 109 | 110 | // If fields has been saved, don't show them again. 111 | if ( isset( $field_group['create_gutenberg_block'] ) && $field_group['create_gutenberg_block'] ) { 112 | return; 113 | } 114 | 115 | $default_category = apply_filters( 'micropackage/acf-block-creator/block-category', $this->config['default_category'] ); 116 | $container_class = apply_filters( 'micropackage/acf-block-creator/block-container-class', $this->config['block_container_class'] ); 117 | 118 | acf_render_field_wrap( [ 119 | 'label' => 'Create Gutenberg block', 120 | 'instructions' => 'Group location will be automatically set to freshly created block', 121 | 'type' => 'true_false', 122 | 'name' => 'create_gutenberg_block', 123 | 'prefix' => 'acf_field_group', 124 | 'value' => false, 125 | 'ui' => true, 126 | ] ); 127 | 128 | acf_render_field_wrap( [ 129 | 'label' => 'Block name', 130 | 'instructions' => '', 131 | 'type' => 'text', 132 | 'name' => 'block_name', 133 | 'prefix' => 'acf_field_group', 134 | 'value' => isset( $field_group['block_name'] ) ? $field_group['block_name'] : '', 135 | ] ); 136 | 137 | acf_render_field_wrap( [ 138 | 'label' => 'Block slug', 139 | 'instructions' => '', 140 | 'type' => 'text', 141 | 'name' => 'block_slug', 142 | 'prefix' => 'acf_field_group', 143 | 'value' => isset( $field_group['block_slug'] ) ? $field_group['block_slug'] : '', 144 | ] ); 145 | 146 | acf_render_field_wrap( [ 147 | 'label' => 'Block category', 148 | 'instructions' => '', 149 | 'type' => 'select', 150 | 'name' => 'block_category', 151 | 'prefix' => 'acf_field_group', 152 | 'value' => isset( $field_group['block_category'] ) ? $field_group['block_category'] : $default_category, 153 | 'choices' => array_reduce( get_block_categories( null ), function( $result, $item ) { 154 | if ( 'reusable' !== $item['slug'] ) { 155 | $result[ $item['slug'] ] = $item['title']; 156 | } 157 | return $result; 158 | }, [] ), 159 | ] ); 160 | 161 | acf_render_field_wrap( [ 162 | 'label' => 'Block align', 163 | 'instructions' => '', 164 | 'type' => 'select', 165 | 'name' => 'block_align', 166 | 'prefix' => 'acf_field_group', 167 | 'value' => isset( $field_group['block_align'] ) ? $field_group['block_align'] : 'full', 168 | 'choices' => [ 169 | 'full' => 'full', 170 | 'center' => 'center', 171 | 'wide' => 'wide', 172 | 'left' => 'left', 173 | 'right' => 'right', 174 | ], 175 | ] ); 176 | 177 | acf_render_field_wrap( [ 178 | 'label' => 'Block container class', 179 | 'instructions' => '', 180 | 'type' => 'text', 181 | 'name' => 'block_container_class', 182 | 'prefix' => 'acf_field_group', 183 | 'value' => isset( $field_group['block_container_class'] ) ? $field_group['block_container_class'] : $container_class, 184 | ] ); 185 | 186 | acf_render_field_wrap( [ 187 | 'label' => 'Use Inner Blocks', 188 | 'instructions' => 'Will add InnerBlocks element to the template', 189 | 'type' => 'true_false', 190 | 'name' => 'inner_blocks', 191 | 'prefix' => 'acf_field_group', 192 | 'value' => false, 193 | 'ui' => false, 194 | ] ); 195 | 196 | } 197 | 198 | /** 199 | * Initiates Block Loader 200 | * 201 | * @action acf/update_field_group 15 202 | * 203 | * @since 1.0.0 204 | * @param array $field_group Field group params. 205 | * @return void 206 | */ 207 | public function update_field_group( $field_group ) { 208 | if ( ! $field_group['create_gutenberg_block'] || empty( $field_group['block_slug'] ) ) { 209 | return; 210 | } 211 | 212 | if ( ! $this->maybe_mkdir( $this->config['blocks_dir'] ) ) { 213 | return; 214 | } 215 | 216 | // Populate fields. 217 | $field_group['fields'] = acf_get_fields( $field_group ); 218 | 219 | // Group location. 220 | $field_group['location'] = [ 221 | [ 222 | [ 223 | 'param' => 'block', 224 | 'operator' => '==', 225 | 'value' => 'acf/' . $field_group['block_slug'], 226 | ], 227 | ], 228 | ]; 229 | 230 | $slug = $field_group['block_slug']; 231 | $comment = []; 232 | 233 | // Add @package comment. 234 | if ( $this->config['package'] ) { 235 | $package = $this->config['package']; 236 | 237 | if ( true === $package ) { 238 | $package = get_bloginfo( 'name' ); 239 | } 240 | 241 | $comment[] = " * @package {$package}"; 242 | } 243 | 244 | // Add @license comment. 245 | if ( is_string( $this->config['license'] ) ) { 246 | $comment[] = " * @license {$this->config['license']}"; 247 | } 248 | 249 | // Add empty line after package/license. 250 | if ( $comment ) { 251 | $comment[] = ' *'; 252 | } 253 | 254 | $block_params = [ 255 | 'Block Name' => $field_group['block_name'], 256 | 'Category' => $field_group['block_category'], 257 | 'Align' => $field_group['block_align'], 258 | ]; 259 | 260 | foreach ( $block_params as $key => $value ) { 261 | $comment[] = " * {$key}: $value"; 262 | } 263 | 264 | // Create block template file. 265 | $fields_markup = []; 266 | foreach ( $field_group['fields'] as $field ) { 267 | $fields_markup[] = $this->get_field_markup( $field ); 268 | } 269 | 270 | // Remove empty markup. 271 | $fields_markup = array_filter( $fields_markup ); 272 | 273 | // Add inner blocks tag. 274 | if ( $field_group['inner_blocks'] ) { 275 | $fields_markup[] = ''; 276 | } 277 | 278 | $template = apply_filters( 279 | 'micropackage/acf-block-creator/block/template', 280 | $this->package_fs->get_contents( 'block.php' ), 281 | $field_group 282 | ); 283 | 284 | $template = str_replace( 285 | [ 286 | '{COMMENT}', 287 | '{FIELDS}', 288 | '{CSS_CLASS}', 289 | ], 290 | [ 291 | substr( implode( "\n", $comment ), 3 ), 292 | implode( "\n", $fields_markup ), 293 | $field_group['block_container_class'], 294 | ], 295 | $template 296 | ); 297 | 298 | $template_dir = apply_filters( 299 | 'micropackage/acf-block-creator/block-template-dir', 300 | $this->config['blocks_dir'], 301 | $slug 302 | ); 303 | 304 | $template_file = apply_filters( 305 | 'micropackage/acf-block-creator/block-template-file', 306 | "{$slug}.php", 307 | $slug 308 | ); 309 | 310 | if ( ! $this->maybe_mkdir( $template_dir ) ) { 311 | return; 312 | } 313 | 314 | $markup = apply_filters( 315 | 'micropackage/acf-block-creator/block/markup', 316 | preg_replace( '/(^[\r\n]*|[\r\n]+)[\s\t]*[\r\n]+/', "\n\n", $template ), 317 | $field_group 318 | ); 319 | 320 | $this->root_fs->put_contents( 321 | "{$template_dir}/{$template_file}", 322 | $markup 323 | ); 324 | 325 | $scss_dir = apply_filters( 326 | 'micropackage/acf-block-creator/block-style-dir', 327 | $this->config['scss_dir'], 328 | $slug 329 | ); 330 | 331 | // Create block scss partial. 332 | if ( is_string( $scss_dir ) ) { 333 | $scss_file = apply_filters( 334 | 'micropackage/acf-block-creator/block-style-file', 335 | "_{$slug}.scss", 336 | $slug 337 | ); 338 | 339 | $scss = ".block.$slug {\n/* stylelint-disable */\n}"; 340 | 341 | if ( $this->maybe_mkdir( $scss_dir ) ) { 342 | $this->root_fs->put_contents( "{$scss_dir}/{$scss_file}", $scss ); 343 | } 344 | } 345 | 346 | /** 347 | * ACF save routine below. 348 | */ 349 | 350 | // Make a backup of field group data and remove some args. 351 | $_field_group = $field_group; 352 | acf_extract_vars( $_field_group, [ 'ID', 'key', 'title', 'menu_order', 'fields', 'active', '_valid' ] ); 353 | 354 | // Create array of data to save. 355 | $save = [ 356 | 'ID' => $field_group['ID'], 357 | 'post_content' => maybe_serialize( $_field_group ), 358 | ]; 359 | 360 | // Unhook wp_targeted_link_rel() filter from WP 5.1 corrupting serialized data. 361 | remove_filter( 'content_save_pre', 'wp_targeted_link_rel' ); 362 | 363 | // Slash data. 364 | // WP expects all data to be slashed and will unslash it (fixes '\' character issues). 365 | wp_update_post( wp_slash( $save ) ); 366 | 367 | // Flush field group cache. 368 | acf_flush_field_group_cache( $field_group ); 369 | 370 | /** 371 | * Fix for JSON save, just resave the file. 372 | */ 373 | if ( acf_get_setting( 'json' ) ) { 374 | acf_write_json_field_group( $field_group ); 375 | } 376 | } 377 | 378 | /** 379 | * Enqueues admin scripts 380 | * 381 | * @action admin_enqueue_scripts 382 | * 383 | * @since 1.0.0 384 | * @return void 385 | */ 386 | public function enqueue_scripts() { 387 | $home_path = wp_normalize_path( get_home_path() ); 388 | $package_path = wp_normalize_path( dirname( dirname( __FILE__ ) ) ); 389 | $script_url = site_url( str_replace( $home_path, '', $package_path ) . '/assets/js/acf-block-creator.js' ); 390 | 391 | wp_enqueue_script( 'acf-block-creator', $script_url, [ 'jquery' ], '1.0.0', true ); 392 | } 393 | 394 | /** 395 | * Checks if directory exists and tries to create it if not 396 | * 397 | * @since 1.0.0 398 | * @param string $dir Directory co check. 399 | * @return bool 400 | */ 401 | private function maybe_mkdir( $dir ) { 402 | if ( ! $this->root_fs->exists( $dir ) ) { 403 | return $this->root_fs->mkdir( $dir, false, false, false, true ); 404 | } 405 | 406 | return true; 407 | } 408 | 409 | /** 410 | * Gets field markup 411 | * 412 | * @since 1.0.0 413 | * @param array $field Field configuration. 414 | * @return string 415 | */ 416 | private function get_field_markup( $field ) { 417 | if ( in_array( $field['type'], $this->excluded_field_types, true ) ) { 418 | return ''; 419 | } 420 | 421 | $markup_file = "fields/{$field['type']}.php"; 422 | $markup_file = $this->package_fs->exists( $markup_file ) ? $markup_file : 'fields/default.php'; 423 | $markup = $this->package_fs->get_contents( $markup_file ); 424 | $subfields = []; 425 | 426 | if ( 'repeater' === $field['type'] ) { 427 | $this->indentation++; 428 | 429 | foreach ( $field['sub_fields'] as $sub_field ) { 430 | $subfields[] = str_replace( 431 | [ 432 | 'get_field(', 433 | 'the_field(', 434 | ], 435 | [ 436 | 'get_sub_field(', 437 | 'the_sub_field(', 438 | ], 439 | $this->get_field_markup( $sub_field ) 440 | ); 441 | } 442 | 443 | $this->indentation--; 444 | } 445 | 446 | $markup = str_replace( 447 | [ 448 | '{name}', 449 | '{subfields}', 450 | "\n", 451 | ], 452 | [ 453 | $field['name'], 454 | implode( "\n", $subfields ), 455 | "\n" . $this->indentation(), 456 | ], 457 | $markup 458 | ); 459 | 460 | return $this->indentation() . $markup; 461 | } 462 | 463 | /** 464 | * Gets current indentation 465 | * 466 | * @since 1.0.3 467 | * @return string 468 | */ 469 | private function indentation() { 470 | return str_repeat( $this->indentation_char, $this->indentation ); 471 | } 472 | } 473 | -------------------------------------------------------------------------------- /composer.lock: -------------------------------------------------------------------------------- 1 | { 2 | "_readme": [ 3 | "This file locks the dependencies of your project to a known state", 4 | "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", 5 | "This file is @generated automatically" 6 | ], 7 | "content-hash": "68ed17752dc5911f14a0d649a49096af", 8 | "packages": [ 9 | { 10 | "name": "micropackage/dochooks", 11 | "version": "1.0.1", 12 | "source": { 13 | "type": "git", 14 | "url": "https://github.com/micropackage/dochooks.git", 15 | "reference": "3dbaf5d50c0677bd465992b76a25df7b0dfe154e" 16 | }, 17 | "dist": { 18 | "type": "zip", 19 | "url": "https://api.github.com/repos/micropackage/dochooks/zipball/3dbaf5d50c0677bd465992b76a25df7b0dfe154e", 20 | "reference": "3dbaf5d50c0677bd465992b76a25df7b0dfe154e", 21 | "shasum": "" 22 | }, 23 | "require": { 24 | "php": ">=5.6" 25 | }, 26 | "require-dev": { 27 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0", 28 | "phpcompatibility/php-compatibility": "^9.1", 29 | "wp-coding-standards/wpcs": "^2.0" 30 | }, 31 | "type": "library", 32 | "autoload": { 33 | "psr-4": { 34 | "Micropackage\\DocHooks\\": "src" 35 | } 36 | }, 37 | "notification-url": "https://packagist.org/downloads/", 38 | "license": [ 39 | "GPL-3.0-or-later" 40 | ], 41 | "authors": [ 42 | { 43 | "name": "Jakub Mikita", 44 | "email": "jakub@bracketspace.com" 45 | } 46 | ], 47 | "description": "DocHooks - annotated WordPress hooks", 48 | "time": "2020-01-28T12:33:02+00:00" 49 | }, 50 | { 51 | "name": "micropackage/filesystem", 52 | "version": "1.1.0", 53 | "source": { 54 | "type": "git", 55 | "url": "https://github.com/micropackage/filesystem.git", 56 | "reference": "362d27f5ad62ccec7e91018fa1a6bf020f604bd7" 57 | }, 58 | "dist": { 59 | "type": "zip", 60 | "url": "https://api.github.com/repos/micropackage/filesystem/zipball/362d27f5ad62ccec7e91018fa1a6bf020f604bd7", 61 | "reference": "362d27f5ad62ccec7e91018fa1a6bf020f604bd7", 62 | "shasum": "" 63 | }, 64 | "require": { 65 | "php": ">=5.6" 66 | }, 67 | "require-dev": { 68 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0", 69 | "phpcompatibility/php-compatibility": "^9.1", 70 | "phpunit/phpunit": "^6.5.5", 71 | "wp-coding-standards/wpcs": "^2.0" 72 | }, 73 | "type": "library", 74 | "autoload": { 75 | "psr-4": { 76 | "Micropackage\\Filesystem\\": "src" 77 | } 78 | }, 79 | "notification-url": "https://packagist.org/downloads/", 80 | "license": [ 81 | "GPL-3.0-or-later" 82 | ], 83 | "authors": [ 84 | { 85 | "name": "Jakub Mikita", 86 | "email": "jakub@bracketspace.com" 87 | } 88 | ], 89 | "description": "Wrapper for WordPress' Filesystem for easier file manipulations.", 90 | "time": "2020-01-29T17:29:21+00:00" 91 | }, 92 | { 93 | "name": "micropackage/singleton", 94 | "version": "1.1.0", 95 | "source": { 96 | "type": "git", 97 | "url": "https://github.com/micropackage/singleton.git", 98 | "reference": "bc69d8ff767cfcfad9a80729c5dc4dcfc89aaf6c" 99 | }, 100 | "dist": { 101 | "type": "zip", 102 | "url": "https://api.github.com/repos/micropackage/singleton/zipball/bc69d8ff767cfcfad9a80729c5dc4dcfc89aaf6c", 103 | "reference": "bc69d8ff767cfcfad9a80729c5dc4dcfc89aaf6c", 104 | "shasum": "" 105 | }, 106 | "require": { 107 | "php": ">=5.6" 108 | }, 109 | "require-dev": { 110 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0", 111 | "phpcompatibility/php-compatibility": "^9.1", 112 | "wp-coding-standards/wpcs": "^2.0" 113 | }, 114 | "type": "library", 115 | "autoload": { 116 | "psr-4": { 117 | "Micropackage\\Singleton\\": "src" 118 | } 119 | }, 120 | "notification-url": "https://packagist.org/downloads/", 121 | "license": [ 122 | "GPL-3.0-or-later" 123 | ], 124 | "authors": [ 125 | { 126 | "name": "Jakub Mikita", 127 | "email": "jakub@bracketspace.com" 128 | } 129 | ], 130 | "description": "Singleton implementation", 131 | "time": "2020-01-28T14:10:39+00:00" 132 | } 133 | ], 134 | "packages-dev": [ 135 | { 136 | "name": "dealerdirect/phpcodesniffer-composer-installer", 137 | "version": "v0.5.0", 138 | "source": { 139 | "type": "git", 140 | "url": "https://github.com/Dealerdirect/phpcodesniffer-composer-installer.git", 141 | "reference": "e749410375ff6fb7a040a68878c656c2e610b132" 142 | }, 143 | "dist": { 144 | "type": "zip", 145 | "url": "https://api.github.com/repos/Dealerdirect/phpcodesniffer-composer-installer/zipball/e749410375ff6fb7a040a68878c656c2e610b132", 146 | "reference": "e749410375ff6fb7a040a68878c656c2e610b132", 147 | "shasum": "" 148 | }, 149 | "require": { 150 | "composer-plugin-api": "^1.0", 151 | "php": "^5.3|^7", 152 | "squizlabs/php_codesniffer": "^2|^3" 153 | }, 154 | "require-dev": { 155 | "composer/composer": "*", 156 | "phpcompatibility/php-compatibility": "^9.0", 157 | "sensiolabs/security-checker": "^4.1.0" 158 | }, 159 | "type": "composer-plugin", 160 | "extra": { 161 | "class": "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin" 162 | }, 163 | "autoload": { 164 | "psr-4": { 165 | "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\": "src/" 166 | } 167 | }, 168 | "notification-url": "https://packagist.org/downloads/", 169 | "license": [ 170 | "MIT" 171 | ], 172 | "authors": [ 173 | { 174 | "name": "Franck Nijhof", 175 | "email": "franck.nijhof@dealerdirect.com", 176 | "homepage": "http://www.frenck.nl", 177 | "role": "Developer / IT Manager" 178 | } 179 | ], 180 | "description": "PHP_CodeSniffer Standards Composer Installer Plugin", 181 | "homepage": "http://www.dealerdirect.com", 182 | "keywords": [ 183 | "PHPCodeSniffer", 184 | "PHP_CodeSniffer", 185 | "code quality", 186 | "codesniffer", 187 | "composer", 188 | "installer", 189 | "phpcs", 190 | "plugin", 191 | "qa", 192 | "quality", 193 | "standard", 194 | "standards", 195 | "style guide", 196 | "stylecheck", 197 | "tests" 198 | ], 199 | "time": "2018-10-26T13:21:45+00:00" 200 | }, 201 | { 202 | "name": "phpcompatibility/php-compatibility", 203 | "version": "9.3.5", 204 | "source": { 205 | "type": "git", 206 | "url": "https://github.com/PHPCompatibility/PHPCompatibility.git", 207 | "reference": "9fb324479acf6f39452e0655d2429cc0d3914243" 208 | }, 209 | "dist": { 210 | "type": "zip", 211 | "url": "https://api.github.com/repos/PHPCompatibility/PHPCompatibility/zipball/9fb324479acf6f39452e0655d2429cc0d3914243", 212 | "reference": "9fb324479acf6f39452e0655d2429cc0d3914243", 213 | "shasum": "" 214 | }, 215 | "require": { 216 | "php": ">=5.3", 217 | "squizlabs/php_codesniffer": "^2.3 || ^3.0.2" 218 | }, 219 | "conflict": { 220 | "squizlabs/php_codesniffer": "2.6.2" 221 | }, 222 | "require-dev": { 223 | "phpunit/phpunit": "~4.5 || ^5.0 || ^6.0 || ^7.0" 224 | }, 225 | "suggest": { 226 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically.", 227 | "roave/security-advisories": "dev-master || Helps prevent installing dependencies with known security issues." 228 | }, 229 | "type": "phpcodesniffer-standard", 230 | "notification-url": "https://packagist.org/downloads/", 231 | "license": [ 232 | "LGPL-3.0-or-later" 233 | ], 234 | "authors": [ 235 | { 236 | "name": "Wim Godden", 237 | "homepage": "https://github.com/wimg", 238 | "role": "lead" 239 | }, 240 | { 241 | "name": "Juliette Reinders Folmer", 242 | "homepage": "https://github.com/jrfnl", 243 | "role": "lead" 244 | }, 245 | { 246 | "name": "Contributors", 247 | "homepage": "https://github.com/PHPCompatibility/PHPCompatibility/graphs/contributors" 248 | } 249 | ], 250 | "description": "A set of sniffs for PHP_CodeSniffer that checks for PHP cross-version compatibility.", 251 | "homepage": "http://techblog.wimgodden.be/tag/codesniffer/", 252 | "keywords": [ 253 | "compatibility", 254 | "phpcs", 255 | "standards" 256 | ], 257 | "time": "2019-12-27T09:44:58+00:00" 258 | }, 259 | { 260 | "name": "squizlabs/php_codesniffer", 261 | "version": "3.5.3", 262 | "source": { 263 | "type": "git", 264 | "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", 265 | "reference": "557a1fc7ac702c66b0bbfe16ab3d55839ef724cb" 266 | }, 267 | "dist": { 268 | "type": "zip", 269 | "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/557a1fc7ac702c66b0bbfe16ab3d55839ef724cb", 270 | "reference": "557a1fc7ac702c66b0bbfe16ab3d55839ef724cb", 271 | "shasum": "" 272 | }, 273 | "require": { 274 | "ext-simplexml": "*", 275 | "ext-tokenizer": "*", 276 | "ext-xmlwriter": "*", 277 | "php": ">=5.4.0" 278 | }, 279 | "require-dev": { 280 | "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0" 281 | }, 282 | "bin": [ 283 | "bin/phpcs", 284 | "bin/phpcbf" 285 | ], 286 | "type": "library", 287 | "extra": { 288 | "branch-alias": { 289 | "dev-master": "3.x-dev" 290 | } 291 | }, 292 | "notification-url": "https://packagist.org/downloads/", 293 | "license": [ 294 | "BSD-3-Clause" 295 | ], 296 | "authors": [ 297 | { 298 | "name": "Greg Sherwood", 299 | "role": "lead" 300 | } 301 | ], 302 | "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.", 303 | "homepage": "https://github.com/squizlabs/PHP_CodeSniffer", 304 | "keywords": [ 305 | "phpcs", 306 | "standards" 307 | ], 308 | "time": "2019-12-04T04:46:47+00:00" 309 | }, 310 | { 311 | "name": "wp-coding-standards/wpcs", 312 | "version": "2.2.0", 313 | "source": { 314 | "type": "git", 315 | "url": "https://github.com/WordPress/WordPress-Coding-Standards.git", 316 | "reference": "f90e8692ce97b693633db7ab20bfa78d930f536a" 317 | }, 318 | "dist": { 319 | "type": "zip", 320 | "url": "https://api.github.com/repos/WordPress/WordPress-Coding-Standards/zipball/f90e8692ce97b693633db7ab20bfa78d930f536a", 321 | "reference": "f90e8692ce97b693633db7ab20bfa78d930f536a", 322 | "shasum": "" 323 | }, 324 | "require": { 325 | "php": ">=5.4", 326 | "squizlabs/php_codesniffer": "^3.3.1" 327 | }, 328 | "require-dev": { 329 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0", 330 | "phpcompatibility/php-compatibility": "^9.0", 331 | "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0" 332 | }, 333 | "suggest": { 334 | "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically." 335 | }, 336 | "type": "phpcodesniffer-standard", 337 | "notification-url": "https://packagist.org/downloads/", 338 | "license": [ 339 | "MIT" 340 | ], 341 | "authors": [ 342 | { 343 | "name": "Contributors", 344 | "homepage": "https://github.com/WordPress/WordPress-Coding-Standards/graphs/contributors" 345 | } 346 | ], 347 | "description": "PHP_CodeSniffer rules (sniffs) to enforce WordPress coding conventions", 348 | "keywords": [ 349 | "phpcs", 350 | "standards", 351 | "wordpress" 352 | ], 353 | "time": "2019-11-11T12:34:03+00:00" 354 | } 355 | ], 356 | "aliases": [], 357 | "minimum-stability": "stable", 358 | "stability-flags": [], 359 | "prefer-stable": false, 360 | "prefer-lowest": false, 361 | "platform": { 362 | "php": ">=5.6" 363 | }, 364 | "platform-dev": [] 365 | } 366 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------