MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
23 use AvroIODatumWriter;
24 use AvroIOBinaryEncoder;
25 use AvroIOTypeException;
26 use AvroNamedSchemata;
27 use AvroSchema;
28 use AvroStringIO;
30 use Monolog\Formatter\FormatterInterface;
39 class AvroFormatter implements FormatterInterface {
43  const MAGIC = 0x0;
47  protected $schemas;
52  protected $io;
57  protected $encoder;
62  protected $writer;
69  public function __construct( array $schemas ) {
70  $this->schemas = $schemas;
71  $this->io = new AvroStringIO( '' );
72  $this->encoder = new AvroIOBinaryEncoder( $this->io );
73  $this->writer = new AvroIODatumWriter();
74  }
84  public function format( array $record ) {
85  $this->io->truncate();
86  $schema = $this->getSchema( $record['channel'] );
87  $revId = $this->getSchemaRevisionId( $record['channel'] );
88  if ( $schema === null || $revId === null ) {
89  trigger_error( "The schema for channel '{$record['channel']}' is not available" );
90  return null;
91  }
92  try {
93  $this->writer->write_data( $schema, $record['context'], $this->encoder );
94  } catch ( AvroIOTypeException $e ) {
95  $errors = AvroValidator::getErrors( $schema, $record['context'] );
96  $json = json_encode( $errors );
97  trigger_error( "Avro failed to serialize record for {$record['channel']} : {$json}" );
98  return null;
99  }
100  return chr( self::MAGIC ) . $this->encodeLong( $revId ) . $this->io->string();
101  }
110  public function formatBatch( array $records ) {
111  $result = [];
112  foreach ( $records as $record ) {
113  $message = $this->format( $record );
114  if ( $message !== null ) {
115  $result[] = $message;
116  }
117  }
118  return $result;
119  }
127  protected function getSchema( $channel ) {
128  if ( !isset( $this->schemas[$channel] ) ) {
129  return null;
130  }
131  if ( !isset( $this->schemas[$channel]['revision'], $this->schemas[$channel]['schema'] ) ) {
132  return null;
133  }
135  if ( !$this->schemas[$channel]['schema'] instanceof AvroSchema ) {
136  $schema = $this->schemas[$channel]['schema'];
137  if ( is_string( $schema ) ) {
138  $this->schemas[$channel]['schema'] = AvroSchema::parse( $schema );
139  } else {
140  $this->schemas[$channel]['schema'] = AvroSchema::real_parse(
141  $schema
142  );
143  }
144  }
145  return $this->schemas[$channel]['schema'];
146  }
154  public function getSchemaRevisionId( $channel ) {
155  if ( isset( $this->schemas[$channel]['revision'] ) ) {
156  return (int)$this->schemas[$channel]['revision'];
157  }
158  return null;
159  }
167  private function encodeLong( $id ) {
168  $high = ( $id & 0xffffffff00000000 ) >> 32;
169  $low = $id & 0x00000000ffffffff;
170  return pack( 'NN', $high, $low );
171  }
172 }
getSchema( $channel)
Definition: AvroFormatter.php:127
AvroIOBinaryEncoder $encoder
Definition: AvroFormatter.php:57
__construct(array $schemas)
Definition: AvroFormatter.php:69
format(array $record)
Formats the record context into a binary string per the schema configured for the records channel.
Definition: AvroFormatter.php:84
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1954
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
Definition: AvroFormatter.php:21
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Log message formatter that uses the apache Avro format.
Definition: AvroFormatter.php:39
Generate error strings for data that doesn't match the specified Avro schema.
Definition: AvroValidator.php:30
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2122
formatBatch(array $records)
Format a set of records into a list of binary strings conforming to the configured schema.
Definition: AvroFormatter.php:110
getSchemaRevisionId( $channel)
Definition: AvroFormatter.php:154
array $schemas
Map from schema name to schema definition.
Definition: AvroFormatter.php:40
static getErrors(AvroSchema $schema, $datum)
Definition: AvroValidator.php:38
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
AvroIODatumWriter $writer
Definition: AvroFormatter.php:62
encodeLong( $id)
convert an integer to a 64bits big endian long (Java compatible) NOTE: certainly only compatible with...
Definition: AvroFormatter.php:167
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context $revId
Definition: hooks.txt:1049
An extension writer
Definition: hooks.txt:51
the array() calling protocol came about after MediaWiki 1.4rc1.
AvroStringIO $io
Definition: AvroFormatter.php:52