source: ZMS/trunk/_deprecatedapi.py @ 1557

Revision 1557, 12.7 KB checked in by zmsdev, 7 months ago (diff)

removed old zms artefacts
Line 
1################################################################################
2# _deprecated.py
3#
4# This program is free software; you can redistribute it and/or
5# modify it under the terms of the GNU General Public License
6# as published by the Free Software Foundation; either version 2
7# of the License, or (at your option) any later version.
8#
9# This program is distributed in the hope that it will be useful,
10# but WITHOUT ANY WARRANTY; without even the implied warranty of
11# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12# GNU General Public License for more details.
13#
14# You should have received a copy of the GNU General Public License
15# along with this program; if not, write to the Free Software
16# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
17################################################################################
18
19# Imports.
20from App.special_dtml import HTMLFile
21import warnings
22# Product Imports.
23import _globals
24import _zreferableitem
25
26
27# ------------------------------------------------------------------------------
28#  getLinkList_ZMSLinkElement:
29#
30#  Returns list of URLs of links.
31# ------------------------------------------------------------------------------
32def getLinkList_ZMSLinkElement(self, REQUEST=None, allow_none=0):
33  value = []
34  ref = self.getObjAttrValue(self.getObjAttr('attr_ref'),REQUEST)
35  dct = {}
36  dct['dst'] = self.getLinkObj(ref,REQUEST)
37  dct['url'] = self.getLinkUrl(ref,REQUEST)
38  dct['title'] = self.getObjProperty('title',REQUEST)
39  dct['description'] = self.getObjProperty('attr_dc_description',REQUEST)
40  dct['internal'] = _zreferableitem.isInternalLink(ref)
41  medline = dct['title'].lower()=='medline'
42  if medline:
43    dct['url'] = _zreferableitem.getMedlineLink(dct['url'])
44  if dct['url'] is not None or allow_none:
45    value.append(dct)
46  return value
47
48
49################################################################################
50################################################################################
51###
52###   class DeprecatedAPI:
53###
54################################################################################
55################################################################################
56class DeprecatedAPI:
57
58  f_bo_area = ''
59  f_eo_area = ''
60
61  # ----------------------------------------------------------------------------
62  #  DeprecatedAPI.getTitleimage
63  # ----------------------------------------------------------------------------
64  def getTitleimage( self, REQUEST):
65    warnings.warn('Using <%s @ %s>.getTitleimage(REQUEST) is deprecated.'
66                 ' Use getObjProperty(\'titleimage\',REQUEST) instead.'%(self.meta_id,self.absolute_url()),
67                   DeprecationWarning,
68                   stacklevel=2)
69    return self.getObjProperty('titleimage',REQUEST)
70
71  # ----------------------------------------------------------------------------
72  #  DeprecatedAPI.getImage
73  # ----------------------------------------------------------------------------
74  def getImage(self,REQUEST):
75    warnings.warn('Using <%s @ %s>.getImage(REQUEST) is deprecated.'
76                 ' Use getObjProperty(\'img\',REQUEST) instead.'%(self.meta_id,self.absolute_url()),
77                   DeprecationWarning,
78                   stacklevel=2)
79    return self.getObjProperty('img',REQUEST)
80
81  # ----------------------------------------------------------------------------
82  #  DeprecatedAPI.getFile
83  # ----------------------------------------------------------------------------
84  def getFile(self,REQUEST):
85    warnings.warn('Using <%s @ %s>.getFile(REQUEST) is deprecated.'
86                 ' Use getObjProperty(\'file\',REQUEST) instead.'%(self.meta_id,self.absolute_url()),
87                   DeprecationWarning,
88                   stacklevel=2)
89    return self.getObjProperty('file',REQUEST)
90
91  # ----------------------------------------------------------------------------
92  #  DeprecatedAPI.getFormat
93  # ----------------------------------------------------------------------------
94  def getFormat(self,REQUEST):
95    print "[getFormat]: @deprecated: returns \"getObjProperty('format',REQUEST)\" for compatibility reasons!"
96    return self.getObjProperty('format',REQUEST)
97
98  # ----------------------------------------------------------------------------
99  #  DeprecatedAPI.getLinkList:
100  #
101  #  Returns list of URLs of links.
102  # ----------------------------------------------------------------------------
103  def getLinkList(self, REQUEST=None, allow_none=0):
104    print "[getLinkList]: @deprecated: use own implementation!"
105   
106    #-- [ReqBuff]: Fetch buffered value from Http-Request.
107    try:
108      reqBuffId = 'getLinkList%i'%allow_none
109      value = self.fetchReqBuff(reqBuffId,REQUEST)
110      return value
111    except:
112     
113      #-- Get value.
114      value = []
115      if self.meta_id == 'ZMSLinkElement' and self.getObjProperty('align',REQUEST) in ['','NONE']:
116        if self.isEmbedded(REQUEST):
117          if self.isPage():
118            ref_obj = self.getRefObj()
119            if ref_obj is not None:
120              value.extend( ref_obj.getLinkList( REQUEST, allow_none))
121        else:
122          value.extend( getLinkList_ZMSLinkElement( self, REQUEST, allow_none))
123      else:
124        for ob in self.filteredChildNodes(REQUEST,['ZMSFile','ZMSLinkContainer','ZMSLinkElement']):
125          if ob.meta_id == 'ZMSLinkContainer':
126            for sub_ob in ob.filteredChildNodes(REQUEST,['ZMSLinkElement']):
127              value.extend( getLinkList_ZMSLinkElement( sub_ob, REQUEST, allow_none))
128          elif ob.meta_id == 'ZMSFile' and ob.getObjProperty('align',REQUEST) in ['','NONE']:
129            f = ob.getFile(REQUEST)
130            if f:
131              dct = {}
132              dct['dst'] = ob
133              dct['url'] = f.getHref(REQUEST)
134              dct['title'] = ob.getTitle(REQUEST)
135              dct['description'] = _globals.nvl(ob.getObjProperty('attr_dc_description',REQUEST),'')
136              dct['internal'] = 1
137              value.append(dct)
138          elif ob.meta_id == 'ZMSLinkElement' and ob.getObjProperty('align',REQUEST) in ['','NONE']:
139            if not ob.isEmbedded(REQUEST):
140              value.extend( getLinkList_ZMSLinkElement( ob, REQUEST, allow_none))
141     
142      #-- [ReqBuff]: Returns value and stores it in buffer of Http-Request.
143      return self.storeReqBuff(reqBuffId,value,REQUEST)
144
145  # ----------------------------------------------------------------------------
146  #  DeprecatedAPI.meta_id_or_type:
147  # ----------------------------------------------------------------------------
148  def meta_id_or_type(self):
149    print "[meta_id_or_type]: @deprecated: use meta_id!"
150    return self.meta_id
151
152  # ----------------------------------------------------------------------------
153  #  DeprecatedAPI.absolute_obj_path:
154  # ----------------------------------------------------------------------------
155  def absolute_obj_path(self):
156    print "[absolute_obj_path]: @deprecated!"
157    ob = self.getDocumentElement()
158    return '%s/%s/'%(ob.aq_parent.id,self.absolute_url()[len(ob.aq_parent.absolute_url())+1:])
159
160  # ----------------------------------------------------------------------------
161  # DeprecatedAPI.manage_adZMS*
162  # ----------------------------------------------------------------------------
163  def manage_addZMSFolder(self, values={}, REQUEST=None):
164    print "[manage_addZMSFolder]: @deprecated!"
165    return self.manage_addZMSCustom('ZMSFolder',values,REQUEST)
166  def manage_addZMSDocument(self, values={}, REQUEST=None):
167    print "[manage_addZMSDocument]: @deprecated!"
168    return self.manage_addZMSCustom('ZMSDocument',values,REQUEST)
169  def manage_addZMSFile(self, values={}, REQUEST=None):
170    print "[manage_addZMSFile]: @deprecated!"
171    return self.manage_addZMSCustom('ZMSFile',values,REQUEST)
172  def manage_addZMSGraphic(self, values={}, REQUEST=None):
173    print "[manage_addZMSGraphic]: @deprecated!"
174    return self.manage_addZMSCustom('ZMSGraphic',values,REQUEST)
175  def manage_addZMSNote(self, values={}, REQUEST=None):
176    print "[manage_addZMSNote]: @deprecated!"
177    return self.manage_addZMSCustom('ZMSNote',values,REQUEST)
178  def manage_addZMSLinkContainer(self, values={}, REQUEST=None):
179    print "[manage_addZMSLinkContainer]: @deprecated!"
180    return self.manage_addZMSCustom('ZMSLinkContainer',values,REQUEST)
181  def manage_addZMSLinkElement(self, values={}, REQUEST=None):
182    print "[manage_addZMSLinkElement]: @deprecated!"
183    return self.manage_addZMSCustom('ZMSLinkElement',values,REQUEST)
184  def manage_addZMSSqlDb(self, values={}, REQUEST=None):
185    print "[manage_addZMSSqlDb]: @deprecated!"
186    return self.manage_addZMSCustom('ZMSSqlDb',values,REQUEST)
187  def manage_addZMSSysFolder(self, values={}, REQUEST=None):
188    print "[manage_addZMSSysFolder]: @deprecated!"
189    return self.manage_addZMSCustom('ZMSSysFolder',values,REQUEST)
190  def manage_addZMSTable(self, values={}, REQUEST=None):
191    print "[manage_addZMSTable]: @deprecated!"
192    return self.manage_addZMSCustom('ZMSTable',values,REQUEST)
193  def manage_addZMSTeaserContainer(self, values={}, REQUEST=None):
194    print "[manage_addZMSTeaserContainer]: @deprecated!"
195    return self.manage_addZMSCustom('ZMSTeaserContainer',values,REQUEST)
196  def manage_addZMSTeaserElement(self, values={}, REQUEST=None):
197    print "[manage_addZMSTeaserElement]: @deprecated!"
198    return self.manage_addZMSCustom('ZMSTeaserElement',values,REQUEST)
199  def manage_addZMSTextarea(self, values={}, REQUEST=None):
200    print "[manage_addZMSTextarea]: @deprecated!"
201    return self.manage_addZMSCustom('ZMSTextarea',values,REQUEST)
202
203  # --------------------------------------------------------------------------
204  #  DeprecatedAPI.pil_img_*:
205  # --------------------------------------------------------------------------
206  def createThumbnail( self, img, maxdim=100, qual=75):
207    """
208    Creates thumbnail of given image.
209    @param img: Image
210    @type img: C{MyImage}
211    @param qual: JPEG quality (default: 75)
212    @type qual: C{int}
213    @return: Thumbnail
214    @rtype: C{MyImage}
215    """
216    warnings.warn('Using <%s @ %s>.createThumbnail(...) is deprecated.'
217                 ' Use pilutil().thumbnail(...) instead.'%(self.meta_id,self.absolute_url()),
218                   DeprecationWarning,
219                   stacklevel=2)
220    return self.pilutil().thumbnail( img, maxdim, qual)
221
222  def pil_img_resize( self, img, size, mode='resize', sffx='_thumbnail', qual=75):
223    """
224    Returns a resized copy of an image. The size argument gives the requested
225    size in pixels, as a 2-tuple: (width, height).
226    @param img: Image
227    @type img: C{MyImage}
228    @param size: Size 2-tuple: (width, height)
229    @type size: C{tuple}
230    @param mode: Mode
231    @type mode: C{string}
232    @param qual: JPEG quality (default: 75)
233    @type qual: C{int}
234    @return: Resized image
235    @rtype: C{MyImage}
236    """
237    warnings.warn('Using <%s @ %s>.pil_img_resize(...) is deprecated.'
238                 ' Use pilutil().resize(...) instead.'%(self.meta_id,self.absolute_url()),
239                   DeprecationWarning,
240                   stacklevel=2)
241    return self.pilutil().resize( img, size, mode, sffx, qual)
242
243  def pil_img_crop( self, img, box, qual=75):
244    """
245    Returns a rectangular region from the current image. The box is a 4-tuple
246    defining the left, upper, right, and lower pixel coordinate.
247    @param img: Image
248    @type img: C{MyImage}
249    @param box Box 4-tuple: (left, upper, right, bottom)
250    @param qual: JPEG quality (default: 75)     
251    @type box: C{tuple}
252    @return: Cropped image
253    @rtype: C{MyImage}
254    """
255    warnings.warn('Using <%s @ %s>.pil_img_crop(...) is deprecated.'
256                 ' Use pilutil().crop(...) instead.'%(self.meta_id,self.absolute_url()),
257                   DeprecationWarning,
258                   stacklevel=2)
259    return self.pilutil().crop( img, box, qual)
260
261  def pil_img_rotate( self, img, direction, qual=75):
262    """
263    Returns rotated version of the current image. Direction is a simple string
264    defining either left (=90 degree rotation clockwise), right (-90 degree) or 180.
265    @param img: Image
266    @type img: C{MyImage}
267    @param direction string: left, right, 180
268    @param qual: JPEG quality (default: 75)
269    @type box: C{string}
270    @return: Rotated image
271    @rtype: C{MyImage}
272    """
273    warnings.warn('Using <%s @ %s>.pil_img_rotate(...) is deprecated.'
274                 ' Use pilutil().rotate(...) instead.'%(self.meta_id,self.absolute_url()),
275                   DeprecationWarning,
276                   stacklevel=2)
277    return self.pilutil().rotate( img, direction, qual)
278
279################################################################################
Note: See TracBrowser for help on using the repository browser.