├── virion.yml ├── .poggit.yml ├── composer.json ├── src └── cosmicpe │ └── awaitform │ ├── AwaitFormException.php │ ├── DialogWindow.php │ ├── FormWindow.php │ ├── Button.php │ ├── MenuWindow.php │ ├── PlayerManager.php │ ├── AwaitForm.php │ ├── ResponseProcessor.php │ └── FormControl.php ├── README.md └── LICENSE /virion.yml: -------------------------------------------------------------------------------- 1 | name: AwaitForm 2 | antigen: cosmicpe\awaitform 3 | api: 5.0.0 4 | version: 0.0.3 5 | author: Muqsit 6 | -------------------------------------------------------------------------------- /.poggit.yml: -------------------------------------------------------------------------------- 1 | --- # Poggit-CI Manifest. Open the CI at https://poggit.pmmp.io/ci/Cosmoverse/AwaitForm 2 | build-by-default: true 3 | branches: 4 | - master 5 | projects: 6 | AwaitForm: 7 | path: "" 8 | model: virion 9 | type: library 10 | ... 11 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cosmicpe/awaitform", 3 | "description": "Write clean form navigation flows in PocketMine-MP using async/await pattern", 4 | "type": "library", 5 | "license": "GPL-3.0-only", 6 | "require": { 7 | "php": "^8.3", 8 | "pocketmine/pocketmine-mp": "^5.0.0", 9 | "sof3/await-generator": "^3.6.1" 10 | }, 11 | "autoload": { 12 | "psr-4": { 13 | "cosmicpe\\awaitform\\": "src/cosmicpe/awaitform" 14 | } 15 | }, 16 | "authors": [ 17 | { 18 | "name": "Muqsit", 19 | "email": "notmuqsit@gmail.com" 20 | } 21 | ], 22 | "extra": { 23 | "virion": { 24 | "spec": "3.0", 25 | "namespace-root": "cosmicpe\\awaitform" 26 | } 27 | } 28 | } -------------------------------------------------------------------------------- /src/cosmicpe/awaitform/AwaitFormException.php: -------------------------------------------------------------------------------- 1 | 24 | */ 25 | public function request(Player $player) : Generator{ 26 | return yield from $this->manager->sendPlayerForm($player, [ 27 | "type" => "modal", 28 | "title" => $this->title, 29 | "content" => $this->content, 30 | "button1" => $this->button1, 31 | "button2" => $this->button2 32 | ], ResponseProcessor::dialog()); 33 | } 34 | 35 | /** 36 | * @template TFallback 37 | * @param Player $player 38 | * @param TFallback $fallback 39 | * @return Generator 40 | */ 41 | public function requestOrFallback(Player $player, mixed $fallback) : Generator{ 42 | try{ 43 | return yield from $this->request($player); 44 | }catch(AwaitFormException){ 45 | return $fallback; 46 | } 47 | } 48 | } -------------------------------------------------------------------------------- /src/cosmicpe/awaitform/FormWindow.php: -------------------------------------------------------------------------------- 1 | $content 22 | */ 23 | public function __construct( 24 | readonly private PlayerManager $manager, 25 | public string $title, 26 | public array $content 27 | ){} 28 | 29 | /** 30 | * @param Player $player 31 | * @return Generator> 32 | */ 33 | public function request(Player $player) : Generator{ 34 | $attributes = [[], [], []]; 35 | foreach($this->content as $index => $value){ 36 | $attributes[0][] = $index; 37 | $attributes[1][] = $value->data; 38 | $attributes[2][] = $value->tags; 39 | } 40 | $response = yield from $this->manager->sendPlayerForm($player, [ 41 | "type" => "custom_form", 42 | "title" => TextFormat::RESET . $this->title, 43 | "content" => $attributes[1] 44 | ], ResponseProcessor::form(), $attributes[2]); 45 | return array_combine($attributes[0], $response); 46 | } 47 | } -------------------------------------------------------------------------------- /src/cosmicpe/awaitform/Button.php: -------------------------------------------------------------------------------- 1 | $text, "image" => null]); 20 | } 21 | 22 | /** 23 | * Creates a button with text and an image path (game resources). 24 | * 25 | * @param string $text 26 | * @param non-empty-string $path 27 | * @return self 28 | */ 29 | public static function withImagePath(string $text, string $path) : self{ 30 | return new self(["text" => $text, "image" => ["type" => self::IMAGE_TYPE_PATH, "data" => $path]]); 31 | } 32 | 33 | /** 34 | * Creates a button with text and an image URL (online source). 35 | * 36 | * @param string $text 37 | * @param non-empty-string $url 38 | * @return self 39 | */ 40 | public static function withImageUrl(string $text, string $url) : self{ 41 | return new self(["text" => $text, "image" => ["type" => self::IMAGE_TYPE_URL, "data" => $url]]); 42 | } 43 | 44 | /** 45 | * @param array{text: string, image: array{type: self::IMAGE_TYPE_*, data: non-empty-string}|null} $data 46 | */ 47 | private function __construct( 48 | readonly public array $data 49 | ){} 50 | } -------------------------------------------------------------------------------- /src/cosmicpe/awaitform/MenuWindow.php: -------------------------------------------------------------------------------- 1 | $buttons 23 | */ 24 | public function __construct( 25 | readonly private PlayerManager $manager, 26 | public string $title, 27 | public string $content, 28 | public array $buttons 29 | ){} 30 | 31 | /** 32 | * @param Player $player 33 | * @return Generator 34 | */ 35 | public function request(Player $player) : Generator{ 36 | $response = yield from $this->manager->sendPlayerForm($player, [ 37 | "type" => "form", 38 | "title" => TextFormat::RESET . $this->title, 39 | "content" => $this->content, 40 | "buttons" => array_map(static fn($x) => $x[0]->data, $this->buttons) 41 | ], ResponseProcessor::menu()); 42 | return $this->buttons[$response][1]; 43 | } 44 | 45 | /** 46 | * @template TFallback 47 | * @param Player $player 48 | * @param TFallback $fallback 49 | * @return Generator 50 | */ 51 | public function requestOrFallback(Player $player, mixed $fallback) : Generator{ 52 | try{ 53 | return yield from $this->request($player); 54 | }catch(AwaitFormException){ 55 | return $fallback; 56 | } 57 | } 58 | } -------------------------------------------------------------------------------- /src/cosmicpe/awaitform/PlayerManager.php: -------------------------------------------------------------------------------- 1 | > 26 | */ 27 | public array $pending = []; 28 | 29 | public function __construct(Plugin $plugin){ 30 | $manager = Server::getInstance()->getPluginManager(); 31 | $manager->registerEvent(PlayerLoginEvent::class, function(PlayerLoginEvent $event) : void{ 32 | $this->pending[$event->getPlayer()->getId()] = []; 33 | }, EventPriority::LOWEST, $plugin); 34 | $manager->registerEvent(PlayerQuitEvent::class, function(PlayerQuitEvent $event) : void{ 35 | $pending = $this->pending[$id = $event->getPlayer()->getId()]; 36 | unset($this->pending[$id]); 37 | foreach($pending as [, $reject]){ 38 | $reject(new AwaitFormException(code: AwaitFormException::ERR_PLAYER_QUIT)); 39 | } 40 | }, EventPriority::LOWEST, $plugin); 41 | } 42 | 43 | /** 44 | * @template TResponseResult 45 | * @param Player $player 46 | * @param ResponseProcessor $processor 47 | * @param array $request 48 | * @param array $tags 49 | * @return Generator 50 | */ 51 | public function sendPlayerForm(Player $player, array $request, ResponseProcessor $processor, array $tags = []) : Generator{ 52 | return yield from Await::promise(function(Closure $resolve, Closure $reject) use($player, $request, $processor, $tags) : void{ 53 | isset($this->pending[$id = $player->getId()]) || throw new AwaitFormException(code: AwaitFormException::ERR_PLAYER_QUIT); 54 | $form = new AwaitForm($request, $tags, $processor); 55 | $this->pending[$id][spl_object_id($form)] = [$resolve, $reject]; 56 | $player->sendForm($form); 57 | }); 58 | } 59 | } -------------------------------------------------------------------------------- /src/cosmicpe/awaitform/AwaitForm.php: -------------------------------------------------------------------------------- 1 | getLogger(), $class->getShortName()); 37 | $logger->warning("Property \$player_manager has not been initialized."); 38 | $logger->warning("This means you likely forgot to register this library on plugin enable."); 39 | $logger->warning("You can address this error by updating your plugin's onEnable method as below:"); 40 | $logger->warning("```"); 41 | $logger->warning("use {$class->name};"); 42 | $logger->warning("protected function onEnable() : void{"); 43 | $logger->warning(" if(!{$class->getShortName()}::isRegistered()){"); 44 | $logger->warning(" {$class->getShortName()}::register(\$this);"); 45 | $logger->warning(" }"); 46 | $logger->warning("}"); 47 | $logger->warning("```"); 48 | throw new InvalidArgumentException("Could not find player manager"); 49 | } 50 | 51 | /** 52 | * Creates a simple two-button dialogue window. 53 | * 54 | * @param string $title 55 | * @param string $content 56 | * @param string $button1 57 | * @param string $button2 58 | * @return DialogWindow 59 | */ 60 | public static function dialog(string $title, string $content, string $button1 = "gui.yes", string $button2 = "gui.no") : DialogWindow{ 61 | return new DialogWindow(self::$player_manager ?? self::playerManagerNotFound(), $title, $content, $button1, $button2); 62 | } 63 | 64 | /** 65 | * Creates a customizable form using various form controls. 66 | * Returns user response mapped to respective $content keys. 67 | * @param string $title 68 | * @param array $content 69 | * @return FormWindow 70 | * @see FormControl for more details. 71 | * 72 | * @template TIndex of string|int 73 | */ 74 | public static function form(string $title, array $content) : FormWindow{ 75 | return new FormWindow(self::$player_manager ?? self::playerManagerNotFound(), $title, $content); 76 | } 77 | 78 | /** 79 | * Creates a multi-button window. Returns index of button corresponding 80 | * to user response. 81 | * 82 | * @template TIndex of string|int 83 | * @param string $title 84 | * @param string $content 85 | * @param array $buttons 86 | * @return MenuWindow 87 | */ 88 | public static function menu(string $title, string $content, array $buttons) : MenuWindow{ 89 | $values = []; 90 | foreach($buttons as $index => $button){ 91 | $values[] = [$button, $index]; 92 | } 93 | return new MenuWindow(self::$player_manager ?? self::playerManagerNotFound(), $title, $content, $values); 94 | } 95 | 96 | /** 97 | * @param array $request 98 | * @param array $tags 99 | * @param ResponseProcessor $processor 100 | */ 101 | public function __construct( 102 | readonly public array $request, 103 | readonly public array $tags, 104 | readonly public ResponseProcessor $processor 105 | ){} 106 | 107 | public function jsonSerialize() : array{ 108 | return $this->request; 109 | } 110 | 111 | public function handleResponse(Player $player, mixed $data) : void{ 112 | if(!isset(self::$player_manager->pending[$id = $player->getId()][$fid = spl_object_id($this)])){ 113 | return; 114 | } 115 | [$resolve, $reject] = self::$player_manager->pending[$id][$fid]; 116 | unset(self::$player_manager->pending[$id][$fid]); 117 | if($data === null){ 118 | $reject(new AwaitFormException(code: AwaitFormException::ERR_PLAYER_REJECTED)); 119 | return; 120 | } 121 | try{ 122 | $data = $this->processor->process($this->request, $this->tags, $data); 123 | }catch(InvalidArgumentException $e){ 124 | $reject(new AwaitFormException(message: $e->getMessage(), code: AwaitFormException::ERR_VALIDATION_FAILED)); 125 | throw new FormValidationException($e->getMessage(), $e->getCode(), $e); 126 | } 127 | $resolve($data); 128 | } 129 | } -------------------------------------------------------------------------------- /src/cosmicpe/awaitform/ResponseProcessor.php: -------------------------------------------------------------------------------- 1 | 29 | */ 30 | public static function dialog() : self{ 31 | /** @var self $instance */ 32 | static $instance = new self(0); 33 | return $instance; 34 | } 35 | 36 | /** 37 | * @return self> 38 | */ 39 | public static function form() : self{ 40 | /** @var self> $instance */ 41 | static $instance = new self(1); 42 | return $instance; 43 | } 44 | 45 | /** 46 | * @return self> 47 | */ 48 | public static function menu() : self{ 49 | /** @var self> $instance */ 50 | static $instance = new self(2); 51 | return $instance; 52 | } 53 | 54 | /** 55 | * @param int<0, 2> $type 56 | */ 57 | private function __construct( 58 | readonly private int $type 59 | ){} 60 | 61 | /** 62 | * @param array $request 63 | * @param array $tags 64 | * @param mixed $response 65 | * @return TReturn 66 | * @throws InvalidArgumentException 67 | */ 68 | public function process(array $request, array $tags, mixed $response) : mixed{ 69 | if($this->type === 0){ 70 | is_bool($response) || throw new InvalidArgumentException("Unexpected response: {$response}, expected boolean"); 71 | return $response; 72 | } 73 | if($this->type === 2){ 74 | is_int($response) || throw new InvalidArgumentException("Unexpected response: " . gettype($response) . ", expected integer"); 75 | isset($request["buttons"][$response]) || throw new InvalidArgumentException("Unexpected response: {$response}, index out of range"); 76 | assert($response >= 0); 77 | return $response; 78 | } 79 | if($this->type === 1){ 80 | is_array($response) || throw new InvalidArgumentException("Unexpected response: " . gettype($response) . ", expected array"); 81 | array_is_list($response) || throw new InvalidArgumentException("Unexpected response, expected array to be a list"); 82 | count($response) === count($request["content"]) || throw new InvalidArgumentException("Unexpected response, expected receiving " . (count($request["content"])) . " values, got " . count($response) . " values"); 83 | foreach($request["content"] as $index => $request_data){ 84 | $value = $response[$index]; 85 | switch($request_data["type"]){ 86 | case "divider": 87 | case "header": 88 | case "label": 89 | $value === null || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]}, expected null"); 90 | break; 91 | case "dropdown": 92 | is_int($value) || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, expected integer"); 93 | $value >= 0 || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, value is negative"); 94 | $value < count($request_data["options"]) || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, value exceeds range"); 95 | $response[$index] = match($tags[$index]["return"]){ 96 | "key" => $value, 97 | "value" => $request_data["options"][$value], 98 | "mapping" => $tags[$index]["mapping"][$value], 99 | default => throw new RuntimeException("Unexpected dropdown return tag: {$tags[$index]["return"]}") 100 | }; 101 | break; 102 | case "input": 103 | is_string($value) || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, expected string"); 104 | break; 105 | case "slider": 106 | is_int($value) || is_float($value) || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, expected numeric"); 107 | $value >= $request_data["min"] || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, expected value >= {$request_data["min"]}, got {$value}"); 108 | $value <= $request_data["max"] || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, expected value <= {$request_data["max"]}, got {$value}"); 109 | break; 110 | case "step_slider": 111 | is_int($value) || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, expected integer"); 112 | $value >= 0 || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, value is negative"); 113 | $value < count($request_data["steps"]) || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, value exceeds range"); 114 | $response[$index] = $request_data["steps"][$value]; 115 | break; 116 | case "toggle": 117 | is_bool($value) || throw new InvalidArgumentException("Unexpected response for {$request_data["type"]} {$request_data["text"]}, expected boolean"); 118 | break; 119 | } 120 | } 121 | return $response; 122 | } 123 | throw new InvalidArgumentException("Invalid type: {$this->type}"); 124 | } 125 | } -------------------------------------------------------------------------------- /src/cosmicpe/awaitform/FormControl.php: -------------------------------------------------------------------------------- 1 | "divider", "text" => ""], ["readonly" => true]); 28 | } 29 | 30 | /** 31 | * @param string $label 32 | * @param non-empty-list $options 33 | * @param int $default 34 | * @param array $tags 35 | * @return self 36 | */ 37 | private static function dropdownGeneric(string $label, array $options, int $default, ?string $tooltip, array $tags = []) : self{ 38 | ($default >= 0 && $default < count($options)) || throw new InvalidArgumentException("Default value index '{$default}' does not exist in options list: '" . implode(", ", $options) . "'"); 39 | return new self(["type" => "dropdown", "text" => $label, "options" => $options, "default" => $default, "tooltip" => $tooltip], $tags); 40 | } 41 | 42 | /** 43 | * Creates a dropdown from a list of choices ($options). $default is a value in 44 | * $options, or null to select the first value in $options by default. Returns 45 | * one of the values from $options as response. 46 | * 47 | * @param string $label 48 | * @param non-empty-list $options 49 | * @param string|null $default 50 | * @return self 51 | */ 52 | public static function dropdown(string $label, array $options, ?string $default = null, ?string $tooltip = null) : self{ 53 | if($default === null){ 54 | $default_index = 0; 55 | }else{ 56 | $default_index = array_search($default, $options, true); 57 | $default_index !== false || throw new InvalidArgumentException("Default value '{$default}' does not exist in options list: '" . implode(", ", $options) . "'"); 58 | } 59 | return self::dropdownGeneric($label, $options, $default_index, $tooltip, ["return" => "value"]); 60 | } 61 | 62 | /** 63 | * Creates a dropdown from a list of choices ($options). $default is an index of 64 | * $options. Returns index position of one of the values from $options as response. 65 | * 66 | * @param string $label 67 | * @param non-empty-list $options 68 | * @param int $default 69 | * @return self 70 | */ 71 | public static function dropdownIndex(string $label, array $options, int $default = 0, ?string $tooltip = null) : self{ 72 | return self::dropdownGeneric($label, $options, $default, $tooltip, ["return" => "key"]); 73 | } 74 | 75 | /** 76 | * Creates a dropdown from a list of choices ($options). $default is a value in 77 | * $options, or null to select the first value in $options by default. A value 78 | * $mapping is preserved server-side for every value in $options. Returns a value 79 | * from $mapping corresponding to the index position in $options of the selected 80 | * user response. 81 | * 82 | * @template TMapping 83 | * @param string $label 84 | * @param non-empty-list $options 85 | * @param non-empty-list $mapping 86 | * @param TMapping|null $default 87 | * @return self 88 | */ 89 | public static function dropdownMap(string $label, array $options, array $mapping, mixed $default = null, ?string $tooltip = null) : self{ 90 | if($default === null){ 91 | $default_index = 0; 92 | }else{ 93 | $default_index = array_search($default, $mapping, true); 94 | $default_index !== false || throw new InvalidArgumentException("Default value '{$default}' does not exist in options list"); 95 | } 96 | return self::dropdownGeneric($label, $options, $default_index, $tooltip, ["return" => "mapping", "mapping" => $mapping]); 97 | } 98 | 99 | /** 100 | * Creates a heading with a larger font size than normal text. 101 | * 102 | * @param string $label 103 | * @return self 104 | */ 105 | public static function header(string $label) : self{ 106 | return new self(["type" => "header", "text" => $label], ["readonly" => true]); 107 | } 108 | 109 | /** 110 | * Creates an input field initialized with a $default value. A non-empty $placeholder 111 | * string may be supplied (such as "Enter text...") for display purpose. Returns the 112 | * raw value supplied in this field as response. 113 | * 114 | * @param string $label 115 | * @param string $placeholder 116 | * @param string $default 117 | * @return self 118 | */ 119 | public static function input(string $label, string $placeholder = "", string $default = "", ?string $tooltip = null) : self{ 120 | return new self(["type" => "input", "text" => $label, "placeholder" => $placeholder, "default" => $default, "tooltip" => $tooltip]); 121 | } 122 | 123 | /** 124 | * Creates a text box that display some given text. 125 | * 126 | * @param string $label 127 | * @return self 128 | */ 129 | public static function label(string $label) : self{ 130 | return new self(["type" => "label", "text" => $label], ["readonly" => true]); 131 | } 132 | 133 | /** 134 | * Creates a numeric slider initialized with a $default value. The user is asked to 135 | * pick a value in the specified range in increments of $step. Returns the float 136 | * value the slider points at. 137 | * 138 | * @param string $label 139 | * @param float $min 140 | * @param float $max 141 | * @param float $step 142 | * @param float $default 143 | * @return self 144 | */ 145 | public static function slider(string $label, float $min, float $max, float $step = 0.0, float $default = 0.0, ?string $tooltip = null) : self{ 146 | return new self(["type" => "slider", "text" => $label, "min" => $min, "max" => $max, "step" => $step, "default" => $default, "tooltip" => $tooltip]); 147 | } 148 | 149 | /** 150 | * Creates a choice slider initialized with a $default value. Similar to a dropdown but 151 | * the user is presented a slider instead. Returns a value in $steps that the slider 152 | * points at. 153 | * 154 | * @param string $label 155 | * @param non-empty-list $steps 156 | * @param string|null $default 157 | * @return self 158 | */ 159 | public static function stepSlider(string $label, array $steps, ?string $default = null, ?string $tooltip = null) : self{ 160 | if($default === null){ 161 | $default_index = 0; 162 | }else{ 163 | $default_index = array_search($default, $steps, true); 164 | $default_index !== false || throw new InvalidArgumentException("Default value '{$default}' does not exist in steps list: '" . implode(", ", $steps) . "'"); 165 | } 166 | return new self(["type" => "step_slider", "text" => $label, "steps" => $steps, "default" => $default_index, "tooltip" => $tooltip]); 167 | } 168 | 169 | /** 170 | * Creates a toggle checkbox initialized with a $default value. Returns a 171 | * boolean value representing whether the checkbox is checked/enabled. 172 | * 173 | * @param string $label 174 | * @param bool $default 175 | * @return self 176 | */ 177 | public static function toggle(string $label, bool $default = false, ?string $tooltip = null) : self{ 178 | return new self(["type" => "toggle", "text" => $label, "default" => $default, "tooltip" => $tooltip]); 179 | } 180 | 181 | /** 182 | * A control is represented as a pair of client-side $data and server-side $tags. 183 | * Tags evaluate how return values from controls must be represented. 184 | * @see ResponseProcessor::process() for more details. 185 | * 186 | * @param array{type: string, text: string}&array $data 187 | * @param array $tags 188 | */ 189 | private function __construct( 190 | readonly public array $data, 191 | readonly public array $tags = [] 192 | ){} 193 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AwaitForm 2 | Write clean form navigation flows in PocketMine-MP using async/await pattern in PHP. 3 | 4 | ## Motive 5 | Form navigation flows are inherently asynchronous. Existing libraries use callbacks or specialized Form classes to 6 | handle responses. Control flow syntax (e.g., while, for, continue, break) cannot be fully utilized as each form handler 7 | gets its own isolated context. This makes several tasks challenging. 8 | 9 | Navigation flow becomes incomprehensible in code when Form A sends user to Form B before bringing them back to Form A, 10 | but this time with different parameters for Form A. This is often encountered with pagination ('Previous Page' and 'Next 11 | Page' buttons), refresh mechanisms (e.g., a 'Refresh' button), and non-dismissible forms (i.e., disallowing users to 12 | back away). 13 | 14 | Other issues left unaddressed by conventional APIs is no way to detect and handle failure when sending forms, no defined 15 | cleanup/finalization routine for navigation flows, and no shared state for nested forms (Form A→B→A). Existing libraries 16 | have incorporated specialized paginated forms to avoid boilerplate, and explicit mechanisms in nested forms to allow 17 | navigating back from child to parent form. 18 | 19 | ## Approach 20 | AwaitForm addresses existing issues through an alternative async/await based form-handling syntax using 21 | [await-generator](https://github.com/SOF3/await-generator). 22 | ```php 23 | $form = AwaitForm::form("Create a Ban Report", [ 24 | FormControl::input("Player", "Enter their gamertag"), 25 | FormControl::dropdown("Ban Reason", ["Hacking", "Spamming", "Toxicity"]), 26 | FormControl::input("Comment", "Any further comments...") 27 | ]); 28 | [$gamertag, $reason, $comment] = yield from $form->request($player); 29 | ``` 30 |
31 | See demo 32 | 33 | ![Ban report form](https://github.com/user-attachments/assets/568c3775-6a2e-42d4-9383-ef559093d750) 34 |
35 | 36 | Users get to utilize native PHP control flow syntax (while, for, continue, break, etc.; see 37 | [Retry Logic in Form](#1-retry-logic-in-form)) instead of a costly reimplementation of existing control structures which 38 | existing libraries achieve using callbacks. AwaitForm features no additional special-purpose mechanism, but still aids 39 | users in making otherwise complex [paginated](#3-paginated-button-menu) and [nested](#4-nested-forms) navigation flows. 40 | ```php 41 | // -- initialization: e.g., make player immobile when viewing form -- 42 | $player->setNoClientPredictions(true); 43 | while(true){ 44 | $form = AwaitForm::form("Set home here?", [FormControl::input("Home Name:")]); 45 | // -- request: send form and wait for response -- 46 | try{ 47 | [$name] = yield from $form->request($player); 48 | }catch(AwaitFormException){ 49 | // -- failure: exit loop if player closes form or disconnects -- 50 | break; 51 | } 52 | // -- evaluate: handle response -- 53 | if(trim($name) === ""){ 54 | $player->sendToastNotification("Invalid Name", "Home name cannot be empty"); 55 | continue; 56 | } 57 | $player->sendMessage("Home '{$name}' set at your location!"); 58 | break; 59 | } 60 | // -- finalization/cleanup: e.g., revert player movement restriction -- 61 | $player->setNoClientPredictions(false); 62 | ``` 63 |
64 | See demo 65 | 66 | https://github.com/user-attachments/assets/ef36329b-a7e9-4d83-bdfe-b7920e3da5d3 67 |
68 | 69 | ### When the user does not respond 70 | Player disconnects, server shutdowns, validation errors, and 'busy status' throw an `AwaitFormException`. Read 71 | `AwaitFormException::getCode()` to narrow down the cause to `ERR_VALIDATION_FAILED`, `ERR_PLAYER_REJECTED`, or 72 | `ERR_PLAYER_QUIT`. 73 | ```php 74 | try{ 75 | $response = yield from $form->request($player); 76 | }catch(AwaitFormException){ 77 | return; 78 | } 79 | $player->sendMessage("Response: " . json_encode($response)); 80 | $player->sendMessage("Report Received, thank you!"); 81 | ``` 82 | 83 | ## Example Design Models 84 | ### 1. Retry logic in form 85 | Revisiting the example above (creating a ban report), player gamertags require validation. In this example, the player 86 | is sent the form again when they enter a wrong gamertag. This design includes State Persistence whereby the user's input 87 | is not lost upon entering a wrong gamertag. 88 | ```php 89 | $gamertag = ""; 90 | $reason = null; 91 | $comment = ""; 92 | while(true){ 93 | $form = AwaitForm::form("Create a Ban Report", [ 94 | FormControl::input("Player", "Enter their gamertag", $gamertag), 95 | FormControl::dropdown("Ban Reason", ["Hacking", "Spamming", "Toxicity"], $reason), 96 | FormControl::input("Comment", "Any further comments...", $comment) 97 | ]); 98 | try{ 99 | [$gamertag, $reason, $comment] = yield from $form->request($player); 100 | }catch(AwaitFormException){ 101 | break; 102 | } 103 | if(!$server->hasOfflinePlayerData($gamertag)){ 104 | $player->sendToastNotification("Player Not Found", "'{$gamertag}' never joined this server."); 105 | continue; 106 | } 107 | $player->sendMessage("Response: " . json_encode([$gamertag, $reason, $comment])); 108 | $player->sendMessage("Report Received, thank you!"); 109 | break; 110 | } 111 | ``` 112 |
113 | See demo 114 | 115 | https://github.com/user-attachments/assets/e75081f5-66c3-44cb-bdcd-fb9ff5b7f1e5 116 |
117 | 118 | ### 2. Non-dismissible form 119 | A player is banned and is forced to acknowledge their ban. If they close the form, the form is sent again - 120 | they cannot back away. They are also given permanent blindness until then. 121 | ```php 122 | // -- initialization: happens before main loop -- 123 | $player->getEffects()->add(new EffectInstance(VanillaEffects::BLINDNESS(), Limits::INT32_MAX)); 124 | while(true){ 125 | $form = AwaitForm::form("You are BANNED!", [ 126 | FormControl::toggle("I acknowledge my ban."), 127 | FormControl::input("Comments", "Type any comments you have...") 128 | ]); 129 | try{ 130 | [$acknowledged, $comments] = yield from $form->request($player); 131 | }catch(AwaitFormException $e){ 132 | if($e->getCode() === AwaitFormException::ERR_PLAYER_QUIT){ 133 | break; 134 | } 135 | continue; 136 | } 137 | if($acknowledged){ 138 | echo "Comments: ", $comments, PHP_EOL; 139 | break; 140 | } 141 | $player->sendToastNotification("Try Again", "Acknowledgement is needed."); 142 | } 143 | $player->getEffects()->remove(VanillaEffects::BLINDNESS()); 144 | ``` 145 |
146 | See demo 147 | 148 | https://github.com/user-attachments/assets/04657987-23ec-4649-96fc-a86f5fe1811e 149 |
150 | 151 | ### 3. Paginated button menu 152 | Players can spawn combat items on a PvP server. 10 items are listed at a time in a menu. 153 | For pagination, there is a 'Previous Page' and a 'Next Page' button at the very end of 154 | the menu. 155 | ```php 156 | // -- initialization: shared state variables used across all pages -- 157 | $items = array_filter(VanillaItems::getAll(), fn($item) => $item instanceof Durable); 158 | $offset = 0; 159 | $length = 10; 160 | while(true){ 161 | $sublist = array_slice($items, $offset, $length); 162 | $buttons = []; 163 | foreach($sublist as $id => $item){ 164 | $buttons[$id] = Button::simple($item->getName()); 165 | } 166 | if($offset > 0) $buttons["prev"] = Button::simple("[Previous Page]"); 167 | if($offset + $length < count($items)) $buttons["next"] = Button::simple("[Next Page]"); 168 | $form = AwaitForm::menu("Free Items!", "Have fun soldier :)", $buttons); 169 | try{ 170 | $response = yield from $form->request($player); 171 | }catch(AwaitFormException){ 172 | break; 173 | } 174 | if($response === "prev"){ 175 | $offset -= $length; // validation by-design: can never go negative 176 | }elseif($response === "next"){ 177 | $offset += $length; 178 | }else{ 179 | $item = $sublist[$response]; 180 | $player->getInventory()->addItem($item); 181 | } 182 | } 183 | ``` 184 |
185 | See demo 186 | 187 | https://github.com/user-attachments/assets/82296361-4741-46f7-b227-a1e577a91083 188 |
189 | 190 | ### 4. Nested forms 191 | Revisiting the first example (creating a ban report), this change adds a confirmation form and a mechanism to store 192 | reports using a Finite State Machine. 193 | 194 | Finite State Machines in modeling user interfaces allow you to think at a higher level of abstraction. Instead of 195 | thinking _"After player fills a ban report; the gamertag and the reason is displayed with a yes/no button to confirm 196 | filing the report"_, you think _"The UI is put in a CONFIRM state upon filing the report"_ and entering the state means 197 | certain things happen. 198 | 199 | ```php 200 | $gamertag = ""; 201 | $reason = null; 202 | $comment = ""; 203 | $state = "CREATE"; 204 | while($state !== "DESTROY"){ 205 | if($state === "CREATE"){ 206 | $form = AwaitForm::form("Create a Ban Report", [ 207 | FormControl::input("Player", "Enter their gamertag", $gamertag), 208 | FormControl::dropdown("Ban Reason", ["Hacking", "Spamming", "Toxicity"], $reason), 209 | FormControl::input("Comment", "Any further comments...", $comment) 210 | ]); 211 | try{ 212 | [$gamertag, $reason, $comment] = yield from $form->request($player); 213 | }catch(AwaitFormException){ 214 | $state = "DESTROY"; 215 | continue; 216 | } 217 | if(!$server->hasOfflinePlayerData($gamertag)){ 218 | $player->sendToastNotification("Player Not Found", "'{$gamertag}' never joined this server."); 219 | continue; 220 | } 221 | $state = "CONFIRM"; 222 | }elseif($state === "CONFIRM"){ 223 | $message = ["Are you sure you would like to file this report? Review your details:"]; 224 | $message[] = "Gamertag: {$gamertag}"; 225 | $message[] = "Reason: {$reason}"; 226 | $message[] = "Comment: {$comment}"; 227 | $form = AwaitForm::menu("Confirm Filing Report?", implode(TextFormat::EOL, $message), [ 228 | "yes" => Button::simple("Confirm"), 229 | "edit" => Button::simple("Make Changes"), 230 | "no" => Button::simple("Cancel") 231 | ]); 232 | $response = yield from $form->requestOrFallback($player, "no"); 233 | $state = match($response){ 234 | "yes" => "WRITE", 235 | "edit" => "CREATE", 236 | "no" => "DESTROY" 237 | }; 238 | }elseif($state === "WRITE"){ 239 | yield from $database->asyncInsert("myplugin.ban_reports", ["offender" => $gamertag, "reason" => $reason, "comment" => $comment]); 240 | if($player->isConnected()){ 241 | $player->sendToastNotification("Report Successful!", "Thank you very much."); 242 | } 243 | $gamertag = ""; 244 | $reason = null; 245 | $comment = ""; 246 | $state = "CREATE"; 247 | } 248 | } 249 | ``` 250 |
251 | See demo 252 | 253 | https://github.com/user-attachments/assets/e654822f-598a-4b67-af93-049de33197a2 254 |
255 | 256 | ## Reusing Forms 257 | Form windows store only display properties and not player state. A form window (i.e., `AwaitForm::dialog()`, 258 | `AwaitForm::form()`, `AwaitForm::menu()`) may be instantiated once and reused multiple times. All window properties that 259 | are not readonly are allowed to be mutated. 260 | ```php 261 | $form = AwaitForm::menu("title", "content", []); 262 | $form->title = "New title"; 263 | $form->buttons[] = [Button::simple("Get free food"), "food"]; 264 | $form->buttons[] = [Button::simple("Get free block"), "block"]; 265 | while(true){ 266 | try{ 267 | yield from $form->request($player); 268 | }catch(AwaitFormException){ 269 | break; 270 | } 271 | } 272 | ``` 273 | -------------------------------------------------------------------------------- /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 | 635 | Copyright (C) 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 | Copyright (C) 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 | --------------------------------------------------------------------------------