code
stringlengths 17
247k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function isUserActivated() {
if (!$this->isLoggedIn()) {
return false;
}
if ($this->isOmnipotent()) {
return true;
}
if ($this->getIsDisabled()) {
return false;
}
if (!$this->getIsApproved()) {
return false;
}
if (PhabricatorUserEmail::isEmailVerificationRequired()) {
if (!$this->getIsEmailVerified()) {
return false;
}
}
return true;
} | Is this a live account which has passed required approvals? Returns true
if this is an enabled, verified (if required), approved (if required)
account, and false otherwise.
@return bool True if this is a standard, usable account. | isUserActivated | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function isResponsive() {
if (!$this->isUserActivated()) {
return false;
}
if (!$this->getIsEmailVerified()) {
return false;
}
return true;
} | Is this a user who we can reasonably expect to respond to requests?
This is used to provide a grey "disabled/unresponsive" dot cue when
rendering handles and tags, so it isn't a surprise if you get ignored
when you ask things of users who will not receive notifications or could
not respond to them (because they are disabled, unapproved, do not have
verified email addresses, etc).
@return bool True if this user can receive and respond to requests from
other humans. | isResponsive | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function getIsStandardUser() {
$type_user = PhabricatorPeopleUserPHIDType::TYPECONST;
return $this->getPHID() && (phid_get_type($this->getPHID()) == $type_user);
} | Returns `true` if this is a standard user who is logged in. Returns `false`
for logged out, anonymous, or external users.
@return bool `true` if the user is a standard user who is logged in with
a normal session. | getIsStandardUser | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function compareUserSetting($key, $value) {
$actual = $this->getUserSetting($key);
return ($actual == $value);
} | Test if a given setting is set to a particular value.
@param const Setting key.
@param wild Value to compare.
@return bool True if the setting has the specified value.
@task settings | compareUserSetting | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function overrideTimezoneIdentifier($identifier) {
$timezone_key = PhabricatorTimezoneSetting::SETTINGKEY;
$this->settingCacheKeys[$timezone_key] = true;
$this->settingCache[$timezone_key] = $identifier;
return $this;
} | Override the user's timezone identifier.
This is primarily useful for unit tests.
@param string New timezone identifier.
@return this
@task settings | overrideTimezoneIdentifier | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function getAwayUntil() {
$availability = $this->availability;
$this->assertAttached($availability);
if (!$availability) {
return null;
}
return idx($availability, 'until');
} | Get the timestamp the user is away until, if they are currently away.
@return int|null Epoch timestamp, or `null` if the user is not away.
@task availability | getAwayUntil | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function getAvailabilityCache() {
$now = PhabricatorTime::getNow();
if ($this->availabilityCacheTTL <= $now) {
return null;
}
try {
return phutil_json_decode($this->availabilityCache);
} catch (Exception $ex) {
return null;
}
} | Get cached availability, if present.
@return wild|null Cache data, or null if no cache is available.
@task availability | getAvailabilityCache | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function writeAvailabilityCache(array $availability, $ttl) {
if (PhabricatorEnv::isReadOnly()) {
return $this;
}
$unguarded = AphrontWriteGuard::beginScopedUnguardedWrites();
queryfx(
$this->establishConnection('w'),
'UPDATE %T SET availabilityCache = %s, availabilityCacheTTL = %nd
WHERE id = %d',
$this->getTableName(),
phutil_json_encode($availability),
$ttl,
$this->getID());
unset($unguarded);
return $this;
} | Write to the availability cache.
@param wild Availability cache data.
@param int|null Cache TTL.
@return this
@task availability | writeAvailabilityCache | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function updateMultiFactorEnrollment() {
$factors = id(new PhabricatorAuthFactorConfigQuery())
->setViewer($this)
->withUserPHIDs(array($this->getPHID()))
->withFactorProviderStatuses(
array(
PhabricatorAuthFactorProviderStatus::STATUS_ACTIVE,
PhabricatorAuthFactorProviderStatus::STATUS_DEPRECATED,
))
->execute();
$enrolled = count($factors) ? 1 : 0;
if ($enrolled !== $this->isEnrolledInMultiFactor) {
$unguarded = AphrontWriteGuard::beginScopedUnguardedWrites();
queryfx(
$this->establishConnection('w'),
'UPDATE %T SET isEnrolledInMultiFactor = %d WHERE id = %d',
$this->getTableName(),
$enrolled,
$this->getID());
unset($unguarded);
$this->isEnrolledInMultiFactor = $enrolled;
}
} | Update the flag storing this user's enrollment in multi-factor auth.
With certain settings, we need to check if a user has MFA on every page,
so we cache MFA enrollment on the user object for performance. Calling this
method synchronizes the cache by examining enrollment records. After
updating the cache, use @{method:getIsEnrolledInMultiFactor} to check if
the user is enrolled.
This method should be called after any changes are made to a given user's
multi-factor configuration.
@return void
@task factors | updateMultiFactorEnrollment | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function getIsEnrolledInMultiFactor() {
return $this->isEnrolledInMultiFactor;
} | Check if the user is enrolled in multi-factor authentication.
Enrolled users have one or more multi-factor authentication sources
attached to their account. For performance, this value is cached. You
can use @{method:updateMultiFactorEnrollment} to update the cache.
@return bool True if the user is enrolled.
@task factors | getIsEnrolledInMultiFactor | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function isOmnipotent() {
return $this->omnipotent;
} | Returns true if this user is omnipotent. Omnipotent users bypass all policy
checks.
@return bool True if the user bypasses policy checks. | isOmnipotent | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public static function getOmnipotentUser() {
static $user = null;
if (!$user) {
$user = new PhabricatorUser();
$user->omnipotent = true;
$user->makeEphemeral();
}
return $user;
} | Get an omnipotent user object for use in contexts where there is no acting
user, notably daemons.
@return PhabricatorUser An omnipotent user. | getOmnipotentUser | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function getCacheFragment() {
if ($this->isOmnipotent()) {
return 'u.omnipotent';
}
$phid = $this->getPHID();
if ($phid) {
return 'u.'.$phid;
}
return 'u.public';
} | Get a scalar string identifying this user.
This is similar to using the PHID, but distinguishes between omnipotent
and public users explicitly. This allows safe construction of cache keys
or cache buckets which do not conflate public and omnipotent users.
@return string Scalar identifier. | getCacheFragment | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function loadHandles(array $phids) {
if ($this->handlePool === null) {
$this->handlePool = id(new PhabricatorHandlePool())
->setViewer($this);
}
return $this->handlePool->newHandleList($phids);
} | Get a @{class:PhabricatorHandleList} which benefits from this viewer's
internal handle pool.
@param list<phid> List of PHIDs to load.
@return PhabricatorHandleList Handle list object.
@task handle | loadHandles | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function renderHandle($phid) {
return $this->loadHandles(array($phid))->renderHandle($phid);
} | Get a @{class:PHUIHandleView} for a single handle.
This benefits from the viewer's internal handle pool.
@param phid PHID to render a handle for.
@return PHUIHandleView View of the handle.
@task handle | renderHandle | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public function renderHandleList(array $phids) {
return $this->loadHandles($phids)->renderList();
} | Get a @{class:PHUIHandleListView} for a list of handles.
This benefits from the viewer's internal handle pool.
@param list<phid> List of PHIDs to render.
@return PHUIHandleListView View of the handles.
@task handle | renderHandleList | php | phacility/phabricator | src/applications/people/storage/PhabricatorUser.php | https://github.com/phacility/phabricator/blob/master/src/applications/people/storage/PhabricatorUser.php | Apache-2.0 |
public static function sortTimeline(array $u, array $v) {
// If these events occur at different times, ordering is obvious.
if ($u['at'] != $v['at']) {
return ($u['at'] < $v['at']) ? -1 : 1;
}
$u_end = ($u['type'] == 'end' || $u['type'] == 'pop');
$v_end = ($v['type'] == 'end' || $v['type'] == 'pop');
$u_id = $u['event']->getID();
$v_id = $v['event']->getID();
if ($u_end == $v_end) {
// These are both start events or both end events. Sort them by ID.
if (!$u_end) {
return ($u_id < $v_id) ? -1 : 1;
} else {
return ($u_id < $v_id) ? 1 : -1;
}
} else {
// Sort them (start, end) if they're the same event, and (end, start)
// otherwise.
if ($u_id == $v_id) {
return $v_end ? -1 : 1;
} else {
return $v_end ? 1 : -1;
}
}
return 0;
} | Sort events in timeline order. Notably, for events which occur on the same
second, we want to process end events after start events. | sortTimeline | php | phacility/phabricator | src/applications/phrequent/storage/PhrequentTimeBlock.php | https://github.com/phacility/phabricator/blob/master/src/applications/phrequent/storage/PhrequentTimeBlock.php | Apache-2.0 |
public function IsSMTP() {
$this->Mailer = 'smtp';
} | Sets Mailer to send message using SMTP.
@return void | IsSMTP | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function IsMail() {
$this->Mailer = 'mail';
} | Sets Mailer to send message using PHP mail() function.
@return void | IsMail | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function IsSendmail() {
if (!stristr(ini_get('sendmail_path'), 'sendmail')) {
$this->Sendmail = '/var/qmail/bin/sendmail';
}
$this->Mailer = 'sendmail';
} | Sets Mailer to send message using the $Sendmail program.
@return void | IsSendmail | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function IsQmail() {
if (stristr(ini_get('sendmail_path'), 'qmail')) {
$this->Sendmail = '/var/qmail/bin/sendmail';
}
$this->Mailer = 'sendmail';
} | Sets Mailer to send message using the qmail MTA.
@return void | IsQmail | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function AddCC($address, $name = '') {
return $this->AddAnAddress('cc', $address, $name);
} | Adds a "Cc" address.
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
@param string $address
@param string $name
@return boolean true on success, false if address already used | AddCC | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function AddBCC($address, $name = '') {
return $this->AddAnAddress('bcc', $address, $name);
} | Adds a "Bcc" address.
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
@param string $address
@param string $name
@return boolean true on success, false if address already used | AddBCC | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
private function AddAnAddress($kind, $address, $name = '') {
if (!preg_match('/^(to|cc|bcc|ReplyTo)$/', $kind)) {
echo 'Invalid recipient array: ' . kind;
return false;
}
$address = trim($address);
$name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
if (!self::ValidateAddress($address)) {
$this->SetError($this->Lang('invalid_address').': '. $address);
if ($this->exceptions) {
throw new phpmailerException($this->Lang('invalid_address').': '.$address);
}
echo $this->Lang('invalid_address').': '.$address;
return false;
}
if ($kind != 'ReplyTo') {
if (!isset($this->all_recipients[strtolower($address)])) {
array_push($this->$kind, array($address, $name));
$this->all_recipients[strtolower($address)] = true;
return true;
}
} else {
if (!array_key_exists(strtolower($address), $this->ReplyTo)) {
$this->ReplyTo[strtolower($address)] = array($address, $name);
return true;
}
}
return false;
} | Adds an address to one of the recipient arrays
Addresses that have been added already return false, but do not throw exceptions
@param string $kind One of 'to', 'cc', 'bcc', 'ReplyTo'
@param string $address The email address to send to
@param string $name
@return boolean true on success, false if address already used or invalid in some way
@access private | AddAnAddress | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function SetFrom($address, $name = '',$auto=1) {
$address = trim($address);
$name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
if (!self::ValidateAddress($address)) {
$this->SetError($this->Lang('invalid_address').': '. $address);
if ($this->exceptions) {
throw new phpmailerException($this->Lang('invalid_address').': '.$address);
}
echo $this->Lang('invalid_address').': '.$address;
return false;
}
$this->From = $address;
$this->FromName = $name;
if ($auto) {
if (empty($this->ReplyTo)) {
$this->AddAnAddress('ReplyTo', $address, $name);
}
if (empty($this->Sender)) {
$this->Sender = $address;
}
}
return true;
} | Set the From and FromName properties
@param string $address
@param string $name
@return boolean | SetFrom | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public static function ValidateAddress($address) {
if (function_exists('filter_var')) { //Introduced in PHP 5.2
if(filter_var($address, FILTER_VALIDATE_EMAIL) === FALSE) {
return false;
} else {
return true;
}
} else {
return preg_match('/^(?:[\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+\.)*[\w\!\#\$\%\&\'\*\+\-\/\=\?\^\`\{\|\}\~]+@(?:(?:(?:[a-zA-Z0-9_](?:[a-zA-Z0-9_\-](?!\.)){0,61}[a-zA-Z0-9_-]?\.)+[a-zA-Z0-9_](?:[a-zA-Z0-9_\-](?!$)){0,61}[a-zA-Z0-9_]?)|(?:\[(?:(?:[01]?\d{1,2}|2[0-4]\d|25[0-5])\.){3}(?:[01]?\d{1,2}|2[0-4]\d|25[0-5])\]))$/', $address);
}
} | Check that a string looks roughly like an email address should
Static so it can be used without instantiation
Tries to use PHP built-in validator in the filter extension (from PHP 5.2), falls back to a reasonably competent regex validator
Conforms approximately to RFC2822
@link http://www.hexillion.com/samples/#Regex Original pattern found here
@param string $address The email address to check
@return boolean
@static
@access public | ValidateAddress | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function Send() {
try {
if ((count($this->to) + count($this->cc) + count($this->bcc)) < 1) {
throw new phpmailerException($this->Lang('provide_address'), self::STOP_CRITICAL);
}
// Set whether the message is multipart/alternative
if(!empty($this->AltBody)) {
$this->ContentType = 'multipart/alternative';
}
$this->error_count = 0; // reset errors
$this->SetMessageType();
$header = $this->CreateHeader();
$body = $this->CreateBody();
if (empty($this->Body)) {
throw new phpmailerException($this->Lang('empty_message'), self::STOP_CRITICAL);
}
// digitally sign with DKIM if enabled
if ($this->DKIM_domain && $this->DKIM_private) {
$header_dkim = $this->DKIM_Add($header,$this->Subject,$body);
$header = str_replace("\r\n","\n",$header_dkim) . $header;
}
// Choose the mailer and send through it
switch($this->Mailer) {
case 'sendmail':
return $this->SendmailSend($header, $body);
case 'smtp':
return $this->SmtpSend($header, $body);
default:
return $this->MailSend($header, $body);
}
} catch (phpmailerException $e) {
$this->SetError($e->getMessage());
if ($this->exceptions) {
throw $e;
}
echo $e->getMessage()."\n";
return false;
}
} | Creates message and assigns Mailer. If the message is
not sent successfully then it returns false. Use the ErrorInfo
variable to view description of the error.
@return bool | Send | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
protected function SmtpSend($header, $body) {
require_once $this->PluginDir . 'class.smtp.php';
$bad_rcpt = array();
if(!$this->SmtpConnect()) {
throw new phpmailerException($this->Lang('smtp_connect_failed'), self::STOP_CRITICAL);
}
$smtp_from = ($this->Sender == '') ? $this->From : $this->Sender;
if(!$this->smtp->Mail($smtp_from)) {
throw new phpmailerException($this->Lang('from_failed') . $smtp_from, self::STOP_CRITICAL);
}
// Attempt to send attach all recipients
foreach($this->to as $to) {
if (!$this->smtp->Recipient($to[0])) {
$bad_rcpt[] = $to[0];
// implement call back function if it exists
$isSent = 0;
$this->doCallback($isSent,$to[0],'','',$this->Subject,$body);
} else {
// implement call back function if it exists
$isSent = 1;
$this->doCallback($isSent,$to[0],'','',$this->Subject,$body);
}
}
foreach($this->cc as $cc) {
if (!$this->smtp->Recipient($cc[0])) {
$bad_rcpt[] = $cc[0];
// implement call back function if it exists
$isSent = 0;
$this->doCallback($isSent,'',$cc[0],'',$this->Subject,$body);
} else {
// implement call back function if it exists
$isSent = 1;
$this->doCallback($isSent,'',$cc[0],'',$this->Subject,$body);
}
}
foreach($this->bcc as $bcc) {
if (!$this->smtp->Recipient($bcc[0])) {
$bad_rcpt[] = $bcc[0];
// implement call back function if it exists
$isSent = 0;
$this->doCallback($isSent,'','',$bcc[0],$this->Subject,$body);
} else {
// implement call back function if it exists
$isSent = 1;
$this->doCallback($isSent,'','',$bcc[0],$this->Subject,$body);
}
}
if (count($bad_rcpt) > 0 ) { //Create error message for any bad addresses
$badaddresses = implode(', ', $bad_rcpt);
throw new phpmailerException($this->Lang('recipients_failed') . $badaddresses);
}
if(!$this->smtp->Data($header . $body)) {
throw new phpmailerException($this->Lang('data_not_accepted'), self::STOP_CRITICAL);
}
if($this->SMTPKeepAlive == true) {
$this->smtp->Reset();
}
return true;
} | Sends mail via SMTP using PhpSMTP
Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
@param string $header The message headers
@param string $body The message body
@uses SMTP
@access protected
@return bool | SmtpSend | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function SmtpConnect() {
if(is_null($this->smtp)) {
$this->smtp = new SMTP();
}
$this->smtp->do_debug = $this->SMTPDebug;
$hosts = explode(';', $this->Host);
$index = 0;
$connection = $this->smtp->Connected();
// Retry while there is no connection
try {
while($index < count($hosts) && !$connection) {
$hostinfo = array();
if (preg_match('/^(.+):([0-9]+)$/', $hosts[$index], $hostinfo)) {
$host = $hostinfo[1];
$port = $hostinfo[2];
} else {
$host = $hosts[$index];
$port = $this->Port;
}
$tls = ($this->SMTPSecure == 'tls');
$ssl = ($this->SMTPSecure == 'ssl');
if ($this->smtp->Connect(($ssl ? 'ssl://':'').$host, $port, $this->Timeout)) {
$hello = ($this->Helo != '' ? $this->Helo : $this->ServerHostname());
$this->smtp->Hello($hello);
if ($tls) {
if (!$this->smtp->StartTLS()) {
throw new phpmailerException($this->Lang('tls'));
}
//We must resend HELO after tls negotiation
$this->smtp->Hello($hello);
}
$connection = true;
if ($this->SMTPAuth) {
if (!$this->smtp->Authenticate($this->Username, $this->Password)) {
throw new phpmailerException($this->Lang('authenticate'));
}
}
}
$index++;
if (!$connection) {
throw new phpmailerException($this->Lang('connect_host'));
}
}
} catch (phpmailerException $e) {
$this->smtp->Reset();
throw $e;
}
return true;
} | Initiates a connection to an SMTP server.
Returns false if the operation failed.
@uses SMTP
@access public
@return bool | SmtpConnect | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function SmtpClose() {
if(!is_null($this->smtp)) {
if($this->smtp->Connected()) {
$this->smtp->Quit();
$this->smtp->Close();
}
}
} | Closes the active SMTP session if one exists.
@return void | SmtpClose | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
function SetLanguage($langcode = 'en', $lang_path = 'language/') {
//Define full set of translatable strings
$PHPMAILER_LANG = array(
'provide_address' => 'You must provide at least one recipient email address.',
'mailer_not_supported' => ' mailer is not supported.',
'execute' => 'Could not execute: ',
'instantiate' => 'Could not instantiate mail function.',
'authenticate' => 'SMTP Error: Could not authenticate.',
'from_failed' => 'The following From address failed: ',
'recipients_failed' => 'SMTP Error: The following recipients failed: ',
'data_not_accepted' => 'SMTP Error: Data not accepted.',
'connect_host' => 'SMTP Error: Could not connect to SMTP host.',
'file_access' => 'Could not access file: ',
'file_open' => 'File Error: Could not open file: ',
'encoding' => 'Unknown encoding: ',
'signing' => 'Signing Error: ',
'smtp_error' => 'SMTP server error: ',
'empty_message' => 'Message body empty',
'invalid_address' => 'Invalid address',
'variable_set' => 'Cannot set or reset variable: '
);
//Overwrite language-specific strings. This way we'll never have missing translations - no more "language string failed to load"!
$l = true;
if ($langcode != 'en') { //There is no English translation file
$l = @include $lang_path.'phpmailer.lang-'.$langcode.'.php';
}
$this->language = $PHPMAILER_LANG;
return ($l == true); //Returns false if language not found
} | Sets the language for all class error messages.
Returns false if it cannot load the language file. The default language is English.
@param string $langcode ISO 639-1 2-character language code (e.g. Portuguese: "br")
@param string $lang_path Path to the language file directory
@access public | SetLanguage | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function GetTranslations() {
return $this->language;
} | Return the current array of language strings
@return array | GetTranslations | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function WrapText($message, $length, $qp_mode = false) {
$soft_break = ($qp_mode) ? sprintf(" =%s", $this->LE) : $this->LE;
// If utf-8 encoding is used, we will need to make sure we don't
// split multibyte characters when we wrap
$is_utf8 = (strtolower($this->CharSet) == "utf-8");
$message = $this->FixEOL($message);
if (substr($message, -1) == $this->LE) {
$message = substr($message, 0, -1);
}
$line = explode($this->LE, $message);
$message = '';
for ($i=0 ;$i < count($line); $i++) {
$line_part = explode(' ', $line[$i]);
$buf = '';
for ($e = 0; $e<count($line_part); $e++) {
$word = $line_part[$e];
if ($qp_mode and (strlen($word) > $length)) {
$space_left = $length - strlen($buf) - 1;
if ($e != 0) {
if ($space_left > 20) {
$len = $space_left;
if ($is_utf8) {
$len = $this->UTF8CharBoundary($word, $len);
} elseif (substr($word, $len - 1, 1) == "=") {
$len--;
} elseif (substr($word, $len - 2, 1) == "=") {
$len -= 2;
}
$part = substr($word, 0, $len);
$word = substr($word, $len);
$buf .= ' ' . $part;
$message .= $buf . sprintf("=%s", $this->LE);
} else {
$message .= $buf . $soft_break;
}
$buf = '';
}
while (strlen($word) > 0) {
$len = $length;
if ($is_utf8) {
$len = $this->UTF8CharBoundary($word, $len);
} elseif (substr($word, $len - 1, 1) == "=") {
$len--;
} elseif (substr($word, $len - 2, 1) == "=") {
$len -= 2;
}
$part = substr($word, 0, $len);
$word = substr($word, $len);
if (strlen($word) > 0) {
$message .= $part . sprintf("=%s", $this->LE);
} else {
$buf = $part;
}
}
} else {
$buf_o = $buf;
$buf .= ($e == 0) ? $word : (' ' . $word);
if (strlen($buf) > $length and $buf_o != '') {
$message .= $buf_o . $soft_break;
$buf = $word;
}
}
}
$message .= $buf . $this->LE;
}
return $message;
} | Wraps message for use with mailers that do not
automatically perform wrapping and for quoted-printable.
Original written by philippe.
@param string $message The message to wrap
@param integer $length The line length to wrap to
@param boolean $qp_mode Whether to run in Quoted-Printable mode
@access public
@return string | WrapText | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function CreateBody() {
$body = '';
if ($this->sign_key_file) {
$body .= $this->GetMailMIME();
}
$this->SetWordWrap();
switch($this->message_type) {
case 'alt':
$body .= $this->GetBoundary($this->boundary[1], '', 'text/plain', '');
$body .= $this->EncodeString($this->AltBody, $this->Encoding);
$body .= $this->LE.$this->LE;
$body .= $this->GetBoundary($this->boundary[1], '', 'text/html', '');
$body .= $this->EncodeString($this->Body, $this->Encoding);
$body .= $this->LE.$this->LE;
$body .= $this->EndBoundary($this->boundary[1]);
break;
case 'plain':
$body .= $this->EncodeString($this->Body, $this->Encoding);
break;
case 'attachments':
$body .= $this->GetBoundary($this->boundary[1], '', '', '');
$body .= $this->EncodeString($this->Body, $this->Encoding);
$body .= $this->LE;
$body .= $this->AttachAll();
break;
case 'alt_attachments':
$body .= sprintf("--%s%s", $this->boundary[1], $this->LE);
$body .= sprintf("Content-Type: %s;%s" . "\tboundary=\"%s\"%s", 'multipart/alternative', $this->LE, $this->boundary[2], $this->LE.$this->LE);
$body .= $this->GetBoundary($this->boundary[2], '', 'text/plain', '') . $this->LE; // Create text body
$body .= $this->EncodeString($this->AltBody, $this->Encoding);
$body .= $this->LE.$this->LE;
$body .= $this->GetBoundary($this->boundary[2], '', 'text/html', '') . $this->LE; // Create the HTML body
$body .= $this->EncodeString($this->Body, $this->Encoding);
$body .= $this->LE.$this->LE;
$body .= $this->EndBoundary($this->boundary[2]);
$body .= $this->AttachAll();
break;
}
if ($this->IsError()) {
$body = '';
} elseif ($this->sign_key_file) {
try {
$file = tempnam('', 'mail');
file_put_contents($file, $body); //TODO check this worked
$signed = tempnam("", "signed");
if (@openssl_pkcs7_sign($file, $signed, "file://".$this->sign_cert_file, array("file://".$this->sign_key_file, $this->sign_key_pass), NULL)) {
@unlink($file);
@unlink($signed);
$body = file_get_contents($signed);
} else {
@unlink($file);
@unlink($signed);
throw new phpmailerException($this->Lang("signing").openssl_error_string());
}
} catch (phpmailerException $e) {
$body = '';
if ($this->exceptions) {
throw $e;
}
}
}
return $body;
} | Assembles the message body. Returns an empty string on failure.
@access public
@return string The assembled message body | CreateBody | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
private function GetBoundary($boundary, $charSet, $contentType, $encoding) {
$result = '';
if($charSet == '') {
$charSet = $this->CharSet;
}
if($contentType == '') {
$contentType = $this->ContentType;
}
if($encoding == '') {
$encoding = $this->Encoding;
}
$result .= $this->TextLine('--' . $boundary);
$result .= sprintf("Content-Type: %s; charset = \"%s\"", $contentType, $charSet);
$result .= $this->LE;
$result .= $this->HeaderLine('Content-Transfer-Encoding', $encoding);
$result .= $this->LE;
return $result;
} | Returns the start of a message boundary.
@access private | GetBoundary | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
private function EndBoundary($boundary) {
return $this->LE . '--' . $boundary . '--' . $this->LE;
} | Returns the end of a message boundary.
@access private | EndBoundary | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function HeaderLine($name, $value) {
return $name . ': ' . $value . $this->LE;
} | Returns a formatted header line.
@access public
@return string | HeaderLine | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function TextLine($value) {
return $value . $this->LE;
} | Returns a formatted mail line.
@access public
@return string | TextLine | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function AddAttachment($path, $name = '', $encoding = 'base64', $type = 'application/octet-stream') {
try {
if ( !@is_file($path) ) {
throw new phpmailerException($this->Lang('file_access') . $path, self::STOP_CONTINUE);
}
$filename = basename($path);
if ( $name == '' ) {
$name = $filename;
}
$this->attachment[] = array(
0 => $path,
1 => $filename,
2 => $name,
3 => $encoding,
4 => $type,
5 => false, // isStringAttachment
6 => 'attachment',
7 => 0
);
} catch (phpmailerException $e) {
$this->SetError($e->getMessage());
if ($this->exceptions) {
throw $e;
}
echo $e->getMessage()."\n";
if ( $e->getCode() == self::STOP_CRITICAL ) {
return false;
}
}
return true;
} | Adds an attachment from a path on the filesystem.
Returns false if the file could not be found
or accessed.
@param string $path Path to the attachment.
@param string $name Overrides the attachment name.
@param string $encoding File encoding (see $Encoding).
@param string $type File extension (MIME) type.
@return bool | AddAttachment | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function GetAttachments() {
return $this->attachment;
} | Return the current array of attachments
@return array | GetAttachments | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
private function EncodeFile($path, $encoding = 'base64') {
try {
if (!is_readable($path)) {
throw new phpmailerException($this->Lang('file_open') . $path, self::STOP_CONTINUE);
}
if (function_exists('get_magic_quotes')) {
function get_magic_quotes() {
return false;
}
}
if (PHP_VERSION < 6) {
$magic_quotes = get_magic_quotes_runtime();
set_magic_quotes_runtime(0);
}
$file_buffer = file_get_contents($path);
$file_buffer = $this->EncodeString($file_buffer, $encoding);
if (PHP_VERSION < 6) { set_magic_quotes_runtime($magic_quotes); }
return $file_buffer;
} catch (Exception $e) {
$this->SetError($e->getMessage());
return '';
}
} | Encodes attachment in requested format.
Returns an empty string on failure.
@param string $path The full path to the file
@param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
@see EncodeFile()
@access private
@return string | EncodeFile | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function EncodeString ($str, $encoding = 'base64') {
$encoded = '';
switch(strtolower($encoding)) {
case 'base64':
$encoded = chunk_split(base64_encode($str), 76, $this->LE);
break;
case '7bit':
case '8bit':
$encoded = $this->FixEOL($str);
//Make sure it ends with a line break
if (substr($encoded, -(strlen($this->LE))) != $this->LE)
$encoded .= $this->LE;
break;
case 'binary':
$encoded = $str;
break;
case 'quoted-printable':
$encoded = $this->EncodeQP($str);
break;
default:
$this->SetError($this->Lang('encoding') . $encoding);
break;
}
return $encoded;
} | Encodes string to requested format.
Returns an empty string on failure.
@param string $str The text to encode
@param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
@access public
@return string | EncodeString | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function EncodeHeader($str, $position = 'text') {
$x = 0;
switch (strtolower($position)) {
case 'phrase':
if (!preg_match('/[\200-\377]/', $str)) {
// Can't use addslashes as we don't know what value has magic_quotes_sybase
$encoded = addcslashes($str, "\0..\37\177\\\"");
if (($str == $encoded) && !preg_match('/[^A-Za-z0-9!#$%&\'*+\/=?^_`{|}~ -]/', $str)) {
return ($encoded);
} else {
return ("\"$encoded\"");
}
}
$x = preg_match_all('/[^\040\041\043-\133\135-\176]/', $str, $matches);
break;
case 'comment':
$x = preg_match_all('/[()"]/', $str, $matches);
// Fall-through
case 'text':
default:
$x += preg_match_all('/[\000-\010\013\014\016-\037\177-\377]/', $str, $matches);
break;
}
if ($x == 0) {
return ($str);
}
$maxlen = 75 - 7 - strlen($this->CharSet);
// Try to select the encoding which should produce the shortest output
if (strlen($str)/3 < $x) {
$encoding = 'B';
if (function_exists('mb_strlen') && $this->HasMultiBytes($str)) {
// Use a custom function which correctly encodes and wraps long
// multibyte strings without breaking lines within a character
$encoded = $this->Base64EncodeWrapMB($str);
} else {
$encoded = base64_encode($str);
$maxlen -= $maxlen % 4;
$encoded = trim(chunk_split($encoded, $maxlen, "\n"));
}
} else {
$encoding = 'Q';
$encoded = $this->EncodeQ($str, $position);
$encoded = $this->WrapText($encoded, $maxlen, true);
$encoded = str_replace('='.$this->LE, "\n", trim($encoded));
}
$encoded = preg_replace('/^(.*)$/m', " =?".$this->CharSet."?$encoding?\\1?=", $encoded);
$encoded = trim(str_replace("\n", $this->LE, $encoded));
return $encoded;
} | Encode a header string to best (shortest) of Q, B, quoted or none.
@access public
@return string | EncodeHeader | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function HasMultiBytes($str) {
if (function_exists('mb_strlen')) {
return (strlen($str) > mb_strlen($str, $this->CharSet));
} else { // Assume no multibytes (we can't handle without mbstring functions anyway)
return false;
}
} | Checks if a string contains multibyte characters.
@access public
@param string $str multi-byte text to wrap encode
@return bool | HasMultiBytes | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function Base64EncodeWrapMB($str) {
$start = "=?".$this->CharSet."?B?";
$end = "?=";
$encoded = "";
$mb_length = mb_strlen($str, $this->CharSet);
// Each line must have length <= 75, including $start and $end
$length = 75 - strlen($start) - strlen($end);
// Average multi-byte ratio
$ratio = $mb_length / strlen($str);
// Base64 has a 4:3 ratio
$offset = $avgLength = floor($length * $ratio * .75);
for ($i = 0; $i < $mb_length; $i += $offset) {
$lookBack = 0;
do {
$offset = $avgLength - $lookBack;
$chunk = mb_substr($str, $i, $offset, $this->CharSet);
$chunk = base64_encode($chunk);
$lookBack++;
}
while (strlen($chunk) > $length);
$encoded .= $chunk . $this->LE;
}
// Chomp the last linefeed
$encoded = substr($encoded, 0, -strlen($this->LE));
return $encoded;
} | Correctly encodes and wraps long multibyte strings for mail headers
without breaking lines within a character.
Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php
@access public
@param string $str multi-byte text to wrap encode
@return string | Base64EncodeWrapMB | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function AddStringAttachment($string, $filename, $encoding = 'base64', $type = 'application/octet-stream') {
// Append to $attachment array
$this->attachment[] = array(
0 => $string,
1 => $filename,
2 => basename($filename),
3 => $encoding,
4 => $type,
5 => true, // isStringAttachment
6 => 'attachment',
7 => 0
);
} | Adds a string or binary attachment (non-filesystem) to the list.
This method can be used to attach ascii or binary data,
such as a BLOB record from a database.
@param string $string String attachment data.
@param string $filename Name of the attachment.
@param string $encoding File encoding (see $Encoding).
@param string $type File extension (MIME) type.
@return void | AddStringAttachment | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function AddEmbeddedImage($path, $cid, $name = '', $encoding = 'base64', $type = 'application/octet-stream') {
if ( !@is_file($path) ) {
$this->SetError($this->Lang('file_access') . $path);
return false;
}
$filename = basename($path);
if ( $name == '' ) {
$name = $filename;
}
// Append to $attachment array
$this->attachment[] = array(
0 => $path,
1 => $filename,
2 => $name,
3 => $encoding,
4 => $type,
5 => false, // isStringAttachment
6 => 'inline',
7 => $cid
);
return true;
} | Adds an embedded attachment. This can include images, sounds, and
just about any other document. Make sure to set the $type to an
image type. For JPEG images use "image/jpeg" and for GIF images
use "image/gif".
@param string $path Path to the attachment.
@param string $cid Content ID of the attachment. Use this to identify
the Id for accessing the image in an HTML form.
@param string $name Overrides the attachment name.
@param string $encoding File encoding (see $Encoding).
@param string $type File extension (MIME) type.
@return bool | AddEmbeddedImage | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function InlineImageExists() {
foreach($this->attachment as $attachment) {
if ($attachment[6] == 'inline') {
return true;
}
}
return false;
} | Returns true if an inline attachment is present.
@access public
@return bool | InlineImageExists | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function ClearReplyTos() {
$this->ReplyTo = array();
} | Clears all recipients assigned in the ReplyTo array. Returns void.
@return void | ClearReplyTos | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function ClearAllRecipients() {
$this->to = array();
$this->cc = array();
$this->bcc = array();
$this->all_recipients = array();
} | Clears all recipients assigned in the TO, CC and BCC
array. Returns void.
@return void | ClearAllRecipients | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function ClearAttachments() {
$this->attachment = array();
} | Clears all previously set filesystem, string, and binary
attachments. Returns void.
@return void | ClearAttachments | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function ClearCustomHeaders() {
$this->CustomHeader = array();
} | Clears all custom headers. Returns void.
@return void | ClearCustomHeaders | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
protected function SetError($msg) {
$this->error_count++;
if ($this->Mailer == 'smtp' and !is_null($this->smtp)) {
$lasterror = $this->smtp->getError();
if (!empty($lasterror) and array_key_exists('smtp_msg', $lasterror)) {
$msg .= '<p>' . $this->Lang('smtp_error') . $lasterror['smtp_msg'] . "</p>\n";
}
}
$this->ErrorInfo = $msg;
} | Adds the error message to the error container.
@access protected
@return void | SetError | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public static function RFCDate() {
$tz = date('Z');
$tzs = ($tz < 0) ? '-' : '+';
$tz = abs($tz);
$tz = (int)($tz/3600)*100 + ($tz%3600)/60;
$result = sprintf("%s %s%04d", date('D, j M Y H:i:s'), $tzs, $tz);
return $result;
} | Returns the proper RFC 822 formatted date.
@access public
@return string
@static | RFCDate | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
private function ServerHostname() {
if (!empty($this->Hostname)) {
$result = $this->Hostname;
} elseif (isset($_SERVER['SERVER_NAME'])) {
$result = $_SERVER['SERVER_NAME'];
} else {
$result = 'localhost.localdomain';
}
return $result;
} | Returns the server hostname or 'localhost.localdomain' if unknown.
@access private
@return string | ServerHostname | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
private function Lang($key) {
if(count($this->language) < 1) {
$this->SetLanguage('en'); // set the default language
}
if(isset($this->language[$key])) {
return $this->language[$key];
} else {
return 'Language string failed to load: ' . $key;
}
} | Returns a message in the appropriate language.
@access private
@return string | Lang | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function IsError() {
return ($this->error_count > 0);
} | Returns true if an error occurred.
@access public
@return bool | IsError | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
private function FixEOL($str) {
$str = str_replace("\r\n", "\n", $str);
$str = str_replace("\r", "\n", $str);
$str = str_replace("\n", $this->LE, $str);
return $str;
} | Changes every end of line from CR or LF to CRLF.
@access private
@return string | FixEOL | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function MsgHTML($message, $basedir = '') {
preg_match_all("/(src|background)=\"(.*)\"/Ui", $message, $images);
if(isset($images[2])) {
foreach($images[2] as $i => $url) {
// do not change urls for absolute images (thanks to corvuscorax)
if (!preg_match('#^[A-z]+://#',$url)) {
$filename = basename($url);
$directory = dirname($url);
($directory == '.')?$directory='':'';
$cid = 'cid:' . md5($filename);
$ext = pathinfo($filename, PATHINFO_EXTENSION);
$mimeType = self::_mime_types($ext);
if ( strlen($basedir) > 1 && substr($basedir,-1) != '/') { $basedir .= '/'; }
if ( strlen($directory) > 1 && substr($directory,-1) != '/') { $directory .= '/'; }
if ( $this->AddEmbeddedImage($basedir.$directory.$filename, md5($filename), $filename, 'base64',$mimeType) ) {
$message = preg_replace("/".$images[1][$i]."=\"".preg_quote($url, '/')."\"/Ui", $images[1][$i]."=\"".$cid."\"", $message);
}
}
}
}
$this->IsHTML(true);
$this->Body = $message;
$textMsg = trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/s','',$message)));
if (!empty($textMsg) && empty($this->AltBody)) {
$this->AltBody = html_entity_decode($textMsg);
}
if (empty($this->AltBody)) {
$this->AltBody = 'To view this email message, open it in a program that understands HTML!' . "\n\n";
}
} | Evaluates the message and returns modifications for inline images and backgrounds
@access public
@return $message | MsgHTML | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public static function _mime_types($ext = '') {
$mimes = array(
'hqx' => 'application/mac-binhex40',
'cpt' => 'application/mac-compactpro',
'doc' => 'application/msword',
'bin' => 'application/macbinary',
'dms' => 'application/octet-stream',
'lha' => 'application/octet-stream',
'lzh' => 'application/octet-stream',
'exe' => 'application/octet-stream',
'class' => 'application/octet-stream',
'psd' => 'application/octet-stream',
'so' => 'application/octet-stream',
'sea' => 'application/octet-stream',
'dll' => 'application/octet-stream',
'oda' => 'application/oda',
'pdf' => 'application/pdf',
'ai' => 'application/postscript',
'eps' => 'application/postscript',
'ps' => 'application/postscript',
'smi' => 'application/smil',
'smil' => 'application/smil',
'mif' => 'application/vnd.mif',
'xls' => 'application/vnd.ms-excel',
'ppt' => 'application/vnd.ms-powerpoint',
'wbxml' => 'application/vnd.wap.wbxml',
'wmlc' => 'application/vnd.wap.wmlc',
'dcr' => 'application/x-director',
'dir' => 'application/x-director',
'dxr' => 'application/x-director',
'dvi' => 'application/x-dvi',
'gtar' => 'application/x-gtar',
'php' => 'application/x-httpd-php',
'php4' => 'application/x-httpd-php',
'php3' => 'application/x-httpd-php',
'phtml' => 'application/x-httpd-php',
'phps' => 'application/x-httpd-php-source',
'js' => 'application/x-javascript',
'swf' => 'application/x-shockwave-flash',
'sit' => 'application/x-stuffit',
'tar' => 'application/x-tar',
'tgz' => 'application/x-tar',
'xhtml' => 'application/xhtml+xml',
'xht' => 'application/xhtml+xml',
'zip' => 'application/zip',
'mid' => 'audio/midi',
'midi' => 'audio/midi',
'mpga' => 'audio/mpeg',
'mp2' => 'audio/mpeg',
'mp3' => 'audio/mpeg',
'aif' => 'audio/x-aiff',
'aiff' => 'audio/x-aiff',
'aifc' => 'audio/x-aiff',
'ram' => 'audio/x-pn-realaudio',
'rm' => 'audio/x-pn-realaudio',
'rpm' => 'audio/x-pn-realaudio-plugin',
'ra' => 'audio/x-realaudio',
'rv' => 'video/vnd.rn-realvideo',
'wav' => 'audio/x-wav',
'bmp' => 'image/bmp',
'gif' => 'image/gif',
'jpeg' => 'image/jpeg',
'jpg' => 'image/jpeg',
'jpe' => 'image/jpeg',
'png' => 'image/png',
'tiff' => 'image/tiff',
'tif' => 'image/tiff',
'css' => 'text/css',
'html' => 'text/html',
'htm' => 'text/html',
'shtml' => 'text/html',
'txt' => 'text/plain',
'text' => 'text/plain',
'log' => 'text/plain',
'rtx' => 'text/richtext',
'rtf' => 'text/rtf',
'xml' => 'text/xml',
'xsl' => 'text/xml',
'mpeg' => 'video/mpeg',
'mpg' => 'video/mpeg',
'mpe' => 'video/mpeg',
'qt' => 'video/quicktime',
'mov' => 'video/quicktime',
'avi' => 'video/x-msvideo',
'movie' => 'video/x-sgi-movie',
'doc' => 'application/msword',
'word' => 'application/msword',
'xl' => 'application/excel',
'eml' => 'message/rfc822'
);
return (!isset($mimes[strtolower($ext)])) ? 'application/octet-stream' : $mimes[strtolower($ext)];
} | Gets the MIME type of the embedded or inline image
@param string File extension
@access public
@return string MIME type of ext
@static | _mime_types | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function SecureHeader($str) {
$str = str_replace("\r", '', $str);
$str = str_replace("\n", '', $str);
return trim($str);
} | Strips newlines to prevent header injection.
@access public
@param string $str String
@return string | SecureHeader | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function Sign($cert_filename, $key_filename, $key_pass) {
$this->sign_cert_file = $cert_filename;
$this->sign_key_file = $key_filename;
$this->sign_key_pass = $key_pass;
} | Set the private key file and password to sign the message.
@access public
@param string $key_filename Parameter File Name
@param string $key_pass Password for private key | Sign | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
public function DKIM_BodyC($body) {
if ($body == '') return "\r\n";
// stabilize line endings
$body=str_replace("\r\n","\n",$body);
$body=str_replace("\n","\r\n",$body);
// END stabilize line endings
while (substr($body,strlen($body)-4,4) == "\r\n\r\n") {
$body=substr($body,0,strlen($body)-2);
}
return $body;
} | Generate DKIM Canonicalization Body
@access public
@param string $body Message Body | DKIM_BodyC | php | phacility/phabricator | externals/phpmailer/class.phpmailer.php | https://github.com/phacility/phabricator/blob/master/externals/phpmailer/class.phpmailer.php | Apache-2.0 |
private function sortRefs(array $refs) {
$repository = $this->getRepository();
$publisher = $repository->newPublisher();
$head_refs = array();
$tail_refs = array();
foreach ($refs as $ref) {
if ($publisher->isPermanentRef($ref)) {
$head_refs[] = $ref;
} else {
$tail_refs[] = $ref;
}
}
return array_merge($head_refs, $tail_refs);
} | Sort refs so we process permanent refs first. This makes the whole import
process a little cheaper, since we can publish these commits the first
time through rather than catching them in the refs step.
@task internal
@param list<DiffusionRepositoryRef> List of refs.
@return list<DiffusionRepositoryRef> Sorted list of refs. | sortRefs | php | phacility/phabricator | src/applications/repository/engine/PhabricatorRepositoryDiscoveryEngine.php | https://github.com/phacility/phabricator/blob/master/src/applications/repository/engine/PhabricatorRepositoryDiscoveryEngine.php | Apache-2.0 |
public function getFieldKeyForConduit() {
return $this->getFieldKey();
} | TODO: It would be nice to remove this, but a lot of different code is
bound together by it. Until everything is modernized, retaining the old
field keys is the only reasonable way to update things one piece
at a time. | getFieldKeyForConduit | php | phacility/phabricator | src/applications/differential/customfield/DifferentialCustomField.php | https://github.com/phacility/phabricator/blob/master/src/applications/differential/customfield/DifferentialCustomField.php | Apache-2.0 |
public function hasAutomaticPolicy() {
return false;
} | Specify that the collector has an automatic retention policy and
is not configurable.
@return bool True if the collector has an automatic retention policy.
@task info | hasAutomaticPolicy | php | phacility/phabricator | src/infrastructure/daemon/garbagecollector/PhabricatorGarbageCollector.php | https://github.com/phacility/phabricator/blob/master/src/infrastructure/daemon/garbagecollector/PhabricatorGarbageCollector.php | Apache-2.0 |
public function getDefaultRetentionPolicy() {
throw new PhutilMethodNotImplementedException();
} | Get the default retention policy for this collector.
Return the age (in seconds) when resources start getting collected, or
`null` to retain resources indefinitely.
@return int|null Lifetime, or `null` for indefinite retention.
@task info | getDefaultRetentionPolicy | php | phacility/phabricator | src/infrastructure/daemon/garbagecollector/PhabricatorGarbageCollector.php | https://github.com/phacility/phabricator/blob/master/src/infrastructure/daemon/garbagecollector/PhabricatorGarbageCollector.php | Apache-2.0 |
public function getRetentionPolicy() {
if ($this->hasAutomaticPolicy()) {
throw new Exception(
pht(
'Can not get retention policy of collector with automatic '.
'policy.'));
}
$config = PhabricatorEnv::getEnvConfig('phd.garbage-collection');
$const = $this->getCollectorConstant();
return idx($config, $const, $this->getDefaultRetentionPolicy());
} | Get the effective retention policy.
@return int|null Lifetime, or `null` for indefinite retention.
@task info | getRetentionPolicy | php | phacility/phabricator | src/infrastructure/daemon/garbagecollector/PhabricatorGarbageCollector.php | https://github.com/phacility/phabricator/blob/master/src/infrastructure/daemon/garbagecollector/PhabricatorGarbageCollector.php | Apache-2.0 |
public function setPath($path) {
// should parse message incrementally from file
$this->resource = mailparse_msg_parse_file($path);
$this->stream = fopen($path, 'r');
$this->parse();
return $this;
} | Set the file path we use to get the email text
@return Object MimeMailParser Instance
@param $mail_path Object | setPath | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
public function setStream($stream) {
// streams have to be cached to file first
if (get_resource_type($stream) == 'stream') {
$tmp_fp = tmpfile();
if ($tmp_fp) {
while(!feof($stream)) {
fwrite($tmp_fp, fread($stream, 2028));
}
fseek($tmp_fp, 0);
$this->stream =& $tmp_fp;
} else {
throw new Exception('Could not create temporary files for attachments. Your tmp directory may be unwritable by PHP.');
return false;
}
fclose($stream);
} else {
$this->stream = $stream;
}
$this->resource = mailparse_msg_create();
// parses the message incrementally low memory usage but slower
while(!feof($this->stream)) {
mailparse_msg_parse($this->resource, fread($this->stream, 2082));
}
$this->parse();
return $this;
} | Set the Stream resource we use to get the email text
@return Object MimeMailParser Instance
@param $stream Resource | setStream | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
public function getHeadersRaw() {
if (isset($this->parts[1])) {
return $this->getPartHeaderRaw($this->parts[1]);
} else {
throw new Exception('MimeMailParser::setPath() or MimeMailParser::setText() must be called before retrieving email headers.');
}
return false;
} | Retrieve the raw Email Headers
@return string | getHeadersRaw | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
public function getHeader($name) {
if (isset($this->parts[1])) {
$headers = $this->getPartHeaders($this->parts[1]);
if (isset($headers[$name])) {
return $headers[$name];
}
} else {
throw new Exception('MimeMailParser::setPath() or MimeMailParser::setText() must be called before retrieving email headers.');
}
return false;
} | Retrieve a specific Email Header
@return String
@param $name String Header name | getHeader | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
public function getMessageBodyHeaders($type = 'text') {
$headers = false;
$mime_types = array(
'text'=> 'text/plain',
'html'=> 'text/html'
);
if (in_array($type, array_keys($mime_types))) {
foreach($this->parts as $part) {
if ($this->getPartContentType($part) == $mime_types[$type]) {
$headers = $this->getPartHeaders($part);
}
}
} else {
throw new Exception('Invalid type specified for MimeMailParser::getMessageBody. "type" can either be text or html.');
}
return $headers;
} | get the headers for the message body part.
@return Array
@param $type Object[optional] | getMessageBodyHeaders | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getPartHeaders($part) {
if (isset($part['headers'])) {
return $part['headers'];
}
return false;
} | Return the Headers for a MIME part
@return Array
@param $part Array | getPartHeaders | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getPartHeader($part, $header) {
if (isset($part['headers'][$header])) {
return $part['headers'][$header];
}
return false;
} | Return a Specific Header for a MIME part
@return Array
@param $part Array
@param $header String Header Name | getPartHeader | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getPartContentType($part) {
if (isset($part['content-type'])) {
return $part['content-type'];
}
return false;
} | Return the ContentType of the MIME part
@return String
@param $part Array | getPartContentType | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getPartContentDisposition($part) {
if (isset($part['content-disposition'])) {
return $part['content-disposition'];
}
return false;
} | Return the Content Disposition
@return String
@param $part Array | getPartContentDisposition | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getPartHeaderRaw(&$part) {
$header = '';
if ($this->stream) {
$header = $this->getPartHeaderFromFile($part);
} else if ($this->data) {
$header = $this->getPartHeaderFromText($part);
} else {
throw new Exception('MimeMailParser::setPath() or MimeMailParser::setText() must be called before retrieving email parts.');
}
return $header;
} | Retrieve the raw Header of a MIME part
@return String
@param $part Object | getPartHeaderRaw | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getPartBody(&$part) {
$body = '';
if ($this->stream) {
$body = $this->getPartBodyFromFile($part);
} else if ($this->data) {
$body = $this->getPartBodyFromText($part);
} else {
throw new Exception('MimeMailParser::setPath() or MimeMailParser::setText() must be called before retrieving email parts.');
}
return $body;
} | Retrieve the Body of a MIME part
@return String
@param $part Object | getPartBody | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getPartHeaderFromFile(&$part) {
$start = $part['starting-pos'];
$end = $part['starting-pos-body'];
fseek($this->stream, $start, SEEK_SET);
$header = fread($this->stream, $end-$start);
return $header;
} | Retrieve the Header from a MIME part from file
@return String Mime Header Part
@param $part Array | getPartHeaderFromFile | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getPartBodyFromFile(&$part) {
$start = $part['starting-pos-body'];
$end = $part['ending-pos-body'];
fseek($this->stream, $start, SEEK_SET);
$body = fread($this->stream, $end-$start);
return $body;
} | Retrieve the Body from a MIME part from file
@return String Mime Body Part
@param $part Array | getPartBodyFromFile | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getPartHeaderFromText(&$part) {
$start = $part['starting-pos'];
$end = $part['starting-pos-body'];
$header = substr($this->data, $start, $end-$start);
return $header;
} | Retrieve the Header from a MIME part from text
@return String Mime Header Part
@param $part Array | getPartHeaderFromText | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getPartBodyFromText(&$part) {
$start = $part['starting-pos-body'];
$end = $part['ending-pos-body'];
$body = substr($this->data, $start, $end-$start);
return $body;
} | Retrieve the Body from a MIME part from text
@return String Mime Body Part
@param $part Array | getPartBodyFromText | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function getAttachmentStream(&$part) {
$temp_fp = tmpfile();
array_key_exists('content-transfer-encoding', $part['headers']) ? $encoding = $part['headers']['content-transfer-encoding'] : $encoding = '';
if ($temp_fp) {
if ($this->stream) {
$start = $part['starting-pos-body'];
$end = $part['ending-pos-body'];
fseek($this->stream, $start, SEEK_SET);
$len = $end-$start;
$written = 0;
$write = 2028;
$body = '';
while($written < $len) {
if (($written+$write < $len )) {
$write = $len - $written;
}
$part = fread($this->stream, $write);
fwrite($temp_fp, $this->decode($part, $encoding));
$written += $write;
}
} else if ($this->data) {
$attachment = $this->decode($this->getPartBodyFromText($part), $encoding);
fwrite($temp_fp, $attachment, strlen($attachment));
}
fseek($temp_fp, 0, SEEK_SET);
} else {
throw new Exception('Could not create temporary files for attachments. Your tmp directory may be unwritable by PHP.');
return false;
}
return $temp_fp;
} | Read the attachment Body and save temporary file resource
@return String Mime Body Part
@param $part Array | getAttachmentStream | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function decode($encodedString, $encodingType) {
if (strtolower($encodingType) == 'base64') {
return base64_decode($encodedString);
} else if (strtolower($encodingType) == 'quoted-printable') {
return quoted_printable_decode($encodedString);
} else {
return $encodedString;
}
} | Decode the string depending on encoding type.
@return String the decoded string.
@param $encodedString The string in its original encoded state.
@param $encodingType The encoding type from the Content-Transfer-Encoding header of the part. | decode | php | phacility/phabricator | externals/mimemailparser/MimeMailParser.class.php | https://github.com/phacility/phabricator/blob/master/externals/mimemailparser/MimeMailParser.class.php | Apache-2.0 |
private function loadSubscription() {
$viewer = PhabricatorUser::getOmnipotentUser();
$data = $this->getTaskData();
$subscription_phid = idx($data, 'subscriptionPHID');
$subscription = id(new PhortuneSubscriptionQuery())
->setViewer($viewer)
->withPHIDs(array($subscription_phid))
->executeOne();
if (!$subscription) {
throw new PhabricatorWorkerPermanentFailureException(
pht(
'Failed to load subscription with PHID "%s".',
$subscription_phid));
}
return $subscription;
} | Load the subscription to generate an invoice for.
@return PhortuneSubscription The subscription to invoice. | loadSubscription | php | phacility/phabricator | src/applications/phortune/worker/PhortuneSubscriptionWorker.php | https://github.com/phacility/phabricator/blob/master/src/applications/phortune/worker/PhortuneSubscriptionWorker.php | Apache-2.0 |
private function getBillingPeriodRange(PhortuneSubscription $subscription) {
$data = $this->getTaskData();
$last_epoch = idx($data, 'trigger.last-epoch');
if (!$last_epoch) {
// If this is the first time the subscription is firing, use the
// creation date as the start of the billing period.
$last_epoch = $subscription->getDateCreated();
}
$this_epoch = idx($data, 'trigger.this-epoch');
if (!$last_epoch || !$this_epoch) {
throw new PhabricatorWorkerPermanentFailureException(
pht('Subscription is missing billing period information.'));
}
$period_length = ($this_epoch - $last_epoch);
if ($period_length <= 0) {
throw new PhabricatorWorkerPermanentFailureException(
pht(
'Subscription has invalid billing period.'));
}
if (empty($data['manual'])) {
if (PhabricatorTime::getNow() < $this_epoch) {
throw new Exception(
pht(
'Refusing to generate a subscription invoice for a billing period '.
'which ends in the future.'));
}
}
return array($last_epoch, $this_epoch);
} | Get the start and end epoch timestamps for this billing period.
@param PhortuneSubscription The subscription being billed.
@return pair<int, int> Beginning and end of the billing range. | getBillingPeriodRange | php | phacility/phabricator | src/applications/phortune/worker/PhortuneSubscriptionWorker.php | https://github.com/phacility/phabricator/blob/master/src/applications/phortune/worker/PhortuneSubscriptionWorker.php | Apache-2.0 |
public function getEngineIdentifier() {
return 'blob';
} | For historical reasons, this engine identifies as "blob". | getEngineIdentifier | php | phacility/phabricator | src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php | https://github.com/phacility/phabricator/blob/master/src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php | Apache-2.0 |
public function writeFile($data, array $params) {
$blob = new PhabricatorFileStorageBlob();
$blob->setData($data);
$blob->save();
return $blob->getID();
} | Write file data into the big blob store table in MySQL. Returns the row
ID as the file data handle. | writeFile | php | phacility/phabricator | src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php | https://github.com/phacility/phabricator/blob/master/src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php | Apache-2.0 |
public function readFile($handle) {
return $this->loadFromMySQLFileStorage($handle)->getData();
} | Load a stored blob from MySQL. | readFile | php | phacility/phabricator | src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php | https://github.com/phacility/phabricator/blob/master/src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php | Apache-2.0 |
private function loadFromMySQLFileStorage($handle) {
$blob = id(new PhabricatorFileStorageBlob())->load($handle);
if (!$blob) {
throw new Exception(pht("Unable to load MySQL blob file '%s'!", $handle));
}
return $blob;
} | Load the Lisk object that stores the file data for a handle.
@param string File data handle.
@return PhabricatorFileStorageBlob Data DAO.
@task internal | loadFromMySQLFileStorage | php | phacility/phabricator | src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php | https://github.com/phacility/phabricator/blob/master/src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php | Apache-2.0 |
public function withTransforms(array $specs) {
foreach ($specs as $spec) {
if (!is_array($spec) ||
empty($spec['originalPHID']) ||
empty($spec['transform'])) {
throw new Exception(
pht(
"Transform specification must be a dictionary with keys ".
"'%s' and '%s'!",
'originalPHID',
'transform'));
}
}
$this->transforms = $specs;
return $this;
} | Select files which are transformations of some other file. For example,
you can use this query to find previously generated thumbnails of an image
file.
As a parameter, provide a list of transformation specifications. Each
specification is a dictionary with the keys `originalPHID` and `transform`.
The `originalPHID` is the PHID of the original file (the file which was
transformed) and the `transform` is the name of the transform to query
for. If you pass `true` as the `transform`, all transformations of the
file will be selected.
For example:
array(
array(
'originalPHID' => 'PHID-FILE-aaaa',
'transform' => 'sepia',
),
array(
'originalPHID' => 'PHID-FILE-bbbb',
'transform' => true,
),
)
This selects the `"sepia"` transformation of the file with PHID
`PHID-FILE-aaaa` and all transformations of the file with PHID
`PHID-FILE-bbbb`.
@param list<dict> List of transform specifications, described above.
@return this | withTransforms | php | phacility/phabricator | src/applications/files/query/PhabricatorFileQuery.php | https://github.com/phacility/phabricator/blob/master/src/applications/files/query/PhabricatorFileQuery.php | Apache-2.0 |
public function getRefForConduit() {
return array(
'id' => (int)$this->getID(),
'phid' => $this->getPHID(),
'name' => $this->getName(),
);
} | Get an abbreviated representation of this project for use in providing
"parent" and "ancestor" information. | getRefForConduit | php | phacility/phabricator | src/applications/project/storage/PhabricatorProject.php | https://github.com/phacility/phabricator/blob/master/src/applications/project/storage/PhabricatorProject.php | Apache-2.0 |
protected function isFirstTimeSetup() {
// If there are any auth providers, this isn't first time setup, even if
// we don't have accounts.
if (PhabricatorAuthProvider::getAllEnabledProviders()) {
return false;
}
// Otherwise, check if there are any user accounts. If not, we're in first
// time setup.
$any_users = id(new PhabricatorPeopleQuery())
->setViewer(PhabricatorUser::getOmnipotentUser())
->setLimit(1)
->execute();
return !$any_users;
} | Returns true if this install is newly setup (i.e., there are no user
accounts yet). In this case, we enter a special mode to permit creation
of the first account form the web UI. | isFirstTimeSetup | php | phacility/phabricator | src/applications/auth/controller/PhabricatorAuthController.php | https://github.com/phacility/phabricator/blob/master/src/applications/auth/controller/PhabricatorAuthController.php | Apache-2.0 |
protected function loginUser(
PhabricatorUser $user,
$force_full_session = false) {
$response = $this->buildLoginValidateResponse($user);
$session_type = PhabricatorAuthSession::TYPE_WEB;
if ($force_full_session) {
$partial_session = false;
} else {
$partial_session = true;
}
$session_key = id(new PhabricatorAuthSessionEngine())
->establishSession($session_type, $user->getPHID(), $partial_session);
// NOTE: We allow disabled users to login and roadblock them later, so
// there's no check for users being disabled here.
$request = $this->getRequest();
$request->setCookie(
PhabricatorCookies::COOKIE_USERNAME,
$user->getUsername());
$request->setCookie(
PhabricatorCookies::COOKIE_SESSION,
$session_key);
$this->clearRegistrationCookies();
return $response;
} | Log a user into a web session and return an @{class:AphrontResponse} which
corresponds to continuing the login process.
Normally, this is a redirect to the validation controller which makes sure
the user's cookies are set. However, event listeners can intercept this
event and do something else if they prefer.
@param PhabricatorUser User to log the viewer in as.
@param bool True to issue a full session immediately, bypassing MFA.
@return AphrontResponse Response which continues the login process. | loginUser | php | phacility/phabricator | src/applications/auth/controller/PhabricatorAuthController.php | https://github.com/phacility/phabricator/blob/master/src/applications/auth/controller/PhabricatorAuthController.php | Apache-2.0 |
public function assertValidRedirectURI($raw_uri) {
// This covers basics like reasonable formatting and the existence of a
// protocol.
PhabricatorEnv::requireValidRemoteURIForLink($raw_uri);
$uri = new PhutilURI($raw_uri);
$fragment = $uri->getFragment();
if (strlen($fragment)) {
throw new Exception(
pht(
'OAuth application redirect URIs must not contain URI '.
'fragments, but the URI "%s" has a fragment ("%s").',
$raw_uri,
$fragment));
}
$protocol = $uri->getProtocol();
switch ($protocol) {
case 'http':
case 'https':
break;
default:
throw new Exception(
pht(
'OAuth application redirect URIs must only use the "http" or '.
'"https" protocols, but the URI "%s" uses the "%s" protocol.',
$raw_uri,
$protocol));
}
} | See http://tools.ietf.org/html/draft-ietf-oauth-v2-23#section-3.1.2
for details on what makes a given redirect URI "valid". | assertValidRedirectURI | php | phacility/phabricator | src/applications/oauthserver/PhabricatorOAuthServer.php | https://github.com/phacility/phabricator/blob/master/src/applications/oauthserver/PhabricatorOAuthServer.php | Apache-2.0 |
public function validateSecondaryRedirectURI(
PhutilURI $secondary_uri,
PhutilURI $primary_uri) {
// The secondary URI must be valid.
if (!$this->validateRedirectURI($secondary_uri)) {
return false;
}
// Both URIs must point at the same domain.
if ($secondary_uri->getDomain() != $primary_uri->getDomain()) {
return false;
}
// Both URIs must have the same path
if ($secondary_uri->getPath() != $primary_uri->getPath()) {
return false;
}
// Both URIs must have the same port
if ($secondary_uri->getPort() != $primary_uri->getPort()) {
return false;
}
// Any query parameters present in the first URI must be exactly present
// in the second URI.
$need_params = $primary_uri->getQueryParamsAsMap();
$have_params = $secondary_uri->getQueryParamsAsMap();
foreach ($need_params as $key => $value) {
if (!array_key_exists($key, $have_params)) {
return false;
}
if ((string)$have_params[$key] != (string)$value) {
return false;
}
}
// If the first URI is HTTPS, the second URI must also be HTTPS. This
// defuses an attack where a third party with control over the network
// tricks you into using HTTP to authenticate over a link which is supposed
// to be HTTPS only and sniffs all your token cookies.
if (strtolower($primary_uri->getProtocol()) == 'https') {
if (strtolower($secondary_uri->getProtocol()) != 'https') {
return false;
}
}
return true;
} | If there's a URI specified in an OAuth request, it must be validated in
its own right. Further, it must have the same domain, the same path, the
same port, and (at least) the same query parameters as the primary URI. | validateSecondaryRedirectURI | php | phacility/phabricator | src/applications/oauthserver/PhabricatorOAuthServer.php | https://github.com/phacility/phabricator/blob/master/src/applications/oauthserver/PhabricatorOAuthServer.php | Apache-2.0 |
public static function getCleanGitWorkspace(
PhabricatorRepository $repo) {
$origin_path = $repo->getLocalPath();
$path = rtrim($origin_path, '/');
$path = $path.'__workspace';
if (!Filesystem::pathExists($path)) {
$repo->execxLocalCommand(
'clone -- file://%s %s',
$origin_path,
$path);
if (!$repo->isHosted()) {
id(new ArcanistGitAPI($path))->execxLocal(
'remote set-url origin %s',
$repo->getRemoteURI());
}
}
$workspace = new ArcanistGitAPI($path);
$workspace->execxLocal('clean -f -d');
$workspace->execxLocal('checkout master');
$workspace->execxLocal('fetch');
$workspace->execxLocal('reset --hard origin/master');
$workspace->reloadWorkingCopy();
return $workspace;
} | Creates and/or cleans a workspace for the requested repo.
return ArcanistGitAPI | getCleanGitWorkspace | php | phacility/phabricator | src/applications/differential/DifferentialGetWorkingCopy.php | https://github.com/phacility/phabricator/blob/master/src/applications/differential/DifferentialGetWorkingCopy.php | Apache-2.0 |
public static function getCleanMercurialWorkspace(
PhabricatorRepository $repo) {
$origin_path = $repo->getLocalPath();
$path = rtrim($origin_path, '/');
$path = $path.'__workspace';
if (!Filesystem::pathExists($path)) {
$repo->execxLocalCommand(
'clone -- file://%s %s',
$origin_path,
$path);
}
$workspace = new ArcanistMercurialAPI($path);
$workspace->execxLocal('pull');
$workspace->execxLocal('update --clean default');
$workspace->reloadWorkingCopy();
return $workspace;
} | Creates and/or cleans a workspace for the requested repo.
return ArcanistMercurialAPI | getCleanMercurialWorkspace | php | phacility/phabricator | src/applications/differential/DifferentialGetWorkingCopy.php | https://github.com/phacility/phabricator/blob/master/src/applications/differential/DifferentialGetWorkingCopy.php | Apache-2.0 |
public function getCommandSyntax() {
return '**!'.$this->getCommand().'**';
} | Return a one-line Remarkup description of command syntax for documentation.
@return string Brief human-readable remarkup.
@task docs | getCommandSyntax | php | phacility/phabricator | src/applications/metamta/command/MetaMTAEmailTransactionCommand.php | https://github.com/phacility/phabricator/blob/master/src/applications/metamta/command/MetaMTAEmailTransactionCommand.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.