Page MenuHomePhabricator

file.upload set policy explicitly
ClosedPublic

Authored by chasemp on Aug 6 2014, 8:39 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Nov 19, 6:51 AM
Unknown Object (File)
Fri, Nov 15, 8:16 AM
Unknown Object (File)
Thu, Nov 14, 4:39 AM
Unknown Object (File)
Mon, Nov 11, 8:24 AM
Unknown Object (File)
Wed, Nov 6, 9:08 PM
Unknown Object (File)
Fri, Oct 25, 2:23 AM
Unknown Object (File)
Oct 22 2024, 5:04 PM
Unknown Object (File)
Oct 22 2024, 3:26 PM

Details

Summary

This is pretty basic allowing a user to set the
policy as a valid string ('no-one' or 'users') or
as a valid PHID. Without an explicit policy
a permissive one is set.

Test Plan

Tested using the python-phabricator module (very basic api wrapper).

The arc cli syntax was evading me.

import base64
from phabricator import Phabricator
phab = Phabricator()
with open('mypic.jpg') as f:
    encoded = base64.b64encode(f.read())

//set no-one as viewer which really means author only?
phab.file.upload(name='mypicnoone.jpg',
                 data_base64=encoded,
                 viewPolicy='no-one')

//set a specific phid as policy in this case a project
phab.file.upload(name='mypicphid.jpg',
                 data_base64=encoded,
                 viewPolicy='PHID-PROJ-fgvvnafmhvkgn2d5a4rf')

//no set policy ends up as 'users' i.e. ('all users')
phab.file.upload(name='mypicdefault.jpg', data_base64=encoded)

Not able to really test canCDN attribute but it should be
fine and I tried to make it all consistent with D10166

Diff Detail

Repository
rP Phabricator
Branch
arcpatch-D10164
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 2074
Build 2087: [Placeholder Plan] Wait for 30 Seconds
Build 2076: [Placeholder Plan] Wait for 30 Seconds

Event Timeline

chasemp retitled this revision from to file.upload set policy explicitly.
chasemp updated this object.
chasemp edited the test plan for this revision. (Show Details)
chasemp added a reviewer: epriestley.
epriestley edited edge metadata.

Minor parameter naming nit.

src/applications/files/conduit/FileUploadConduitAPIMethod.php
17

This should be viewPolicy, to avoid ambiguity with editPolicy. While Files may not ever have a mutable editPolicy, other object types will, and it's more consistent if they all end up with their view policy called viewPolicy than if it's sometimes viewPolicy and sometimes policy.

This revision now requires changes to proceed.Aug 6 2014, 9:03 PM
20after4 added a reviewer: chasemp.
20after4 added a subscriber: 20after4.

adding can_cdn parameter and fixing up the policy->view_policy nit....I hope this isn't stepping on @rush898's toes too much :)

20after4 edited edge metadata.
  • policy becomes view_policy
  • Added can_cdn flag since I was about to do that in a separate diff, this seemed appropriate..
src/applications/files/conduit/FileUploadConduitAPIMethod.php
43

@epriestley: what do you think about setting can_cdn=true when the default view policy is public?

if ($view_policy == PhabricatorPolicies::POLICY_PUBLIC) {
  $cdn = true;
}
chasemp edited reviewers, added: 20after4; removed: chasemp.
chasemp edited edge metadata.

updating for consistency

epriestley edited edge metadata.

I like the explicitness of not coupling canCDN/viewPolicy -- I think API callers likely benefit most from an explicit API. I think we should default it off (i.e., make the default more secure), though, like file uploads elsewhere. This looks good otherwise, just kill those three lines?

src/applications/files/conduit/FileUploadConduitAPIMethod.php
45–47

I think it's OK to leave this off by default -- it's off by default for web UI uploads.

This revision now requires changes to proceed.Aug 7 2014, 4:38 PM
src/applications/files/conduit/FileUploadConduitAPIMethod.php
45–47

don't make it explicit false by default then?

chasemp edited edge metadata.

no true by default for can_cnd

epriestley edited edge metadata.

(canCDN has no effect until D10166, but that's fine.)

This revision is now accepted and ready to land.Aug 7 2014, 7:14 PM
epriestley updated this revision to Diff 24486.

Closed by commit rP6a69b4699ecb (authored by cpettet <rush@wikimedia.org>, committed by @epriestley).